update MANIFEST
[id3fs.git] / README
1                                 id3fs
2                                 -----
3                http://erislabs.net/ianb/projects/id3fs/
4
5 id3fs provides a browsable filesystem of your music files, organised
6 into sub-directories by id3 tags (or flac/ogg comments).
7
8 id3fs allows you to construct boolean queries from a tag folksonomy
9 such as:
10
11 goth/AND/decade/1980s/
12 postrock/AND/NOT/rating/terrible/
13 thrash/OR/rapmetal/AND/NOT/wears-a-red-hat/
14 prog/AND/decade/1970s/OR/psychedelia/AND/decade/1960s/
15 location/sweden/AND/screamo/AND/postrock/
16
17 GETTING ID3FS
18
19 See http://erislabs.net/ianb/projects/id3fs/
20 for source and debian packages.
21
22 DEPENDENCIES
23
24 Linux (or something else that supports FUSE)
25 Perl
26 Perl modules:
27     Fuse (libfuse-perl)
28     DBI (libdbi-perl)
29     DBD::SQLite (libdbd-sqlite3-perl)
30
31 INSTALL
32
33 Use the standard:
34
35 $ perl Makefile.PL
36 $ make
37 $ sudo make install
38
39 or get the Debian package from http://erislabs.net/ianb/projects/id3fs/
40
41 QUICKSTART
42
43 To mount a view of ~/music on ~/tags:
44
45 $ mkdir ~/tags
46 $ id3fs-index ~/music
47 $ id3fsd ~/music ~/tags
48
49 You may need to be in the 'fuse' group, or be root.
50
51 For more details see the man pages for id3fsd(8) and id3fs-index(1).
52
53 REPORTING BUGS
54
55 Please send comments, bugs and patches to ianb@erislabs.net