doc tweaks
[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 Multiple tags can be stored in the genre tag, separated by commas.
18
19 GETTING ID3FS
20
21 See http://erislabs.net/ianb/projects/id3fs/
22 for source and debian packages.
23
24 DEPENDENCIES
25
26 An operating system that supports FUSE (Linux, FreeBSD, NetBSD, GNU/Hurd, etc)
27 Perl
28 Perl modules:
29     Fuse (libfuse-perl)
30     DBI (libdbi-perl)
31     DBD::SQLite (libdbd-sqlite3-perl)
32
33 INSTALL
34
35 Use the standard:
36
37 $ perl Makefile.PL
38 $ make
39 $ sudo make install
40
41 or get the Debian package from http://erislabs.net/ianb/projects/id3fs/
42
43 QUICKSTART
44
45 To mount a view of ~/music on ~/tags:
46
47 $ mkdir ~/tags
48 $ id3fs-index ~/music
49 $ id3fsd ~/music ~/tags
50
51 You may need to be in the 'fuse' group, or be root.
52
53 For more details see the man pages for id3fsd(8) and id3fs-index(1).
54
55 REPORTING BUGS
56
57 Please send comments, bugs and patches to ianb@erislabs.net