add README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..505d614
--- /dev/null
+++ b/README
@@ -0,0 +1,55 @@
+                               id3fs
+                               -----
+              http://erislabs.net/ianb/projects/id3fs/
+
+id3fs provides a browsable filesystem of your music files, organised
+into sub-directories by id3 tags (or flac/ogg comments).
+
+id3fs allows you to construct boolean queries from a tag folksonomy
+such as:
+
+goth/AND/decade/1980s/
+postrock/AND/NOT/rating/terrible/
+thrash/OR/rapmetal/AND/NOT/wears-a-red-hat/
+prog/AND/decade/1970s/OR/psychedelia/AND/decade/1960s/
+location/sweden/AND/screamo/AND/postrock/
+
+GETTING ID3FS
+
+See http://erislabs.net/ianb/projects/id3fs/
+for source and debian packages.
+
+DEPENDENCIES
+
+Linux (or something else that supports FUSE)
+Perl
+Perl modules:
+    Fuse (libfuse-perl)
+    DBI (libdbi-perl)
+    DBD::SQLite (libdbd-sqlite3-perl)
+
+INSTALL
+
+Use the standard:
+
+$ perl Makefile.PL
+$ make
+$ sudo make install
+
+or get the Debian package from http://erislabs.net/ianb/projects/id3fs/
+
+QUICKSTART
+
+To mount a view of ~/music on ~/tags:
+
+$ mkdir ~/tags
+$ id3fs-index ~/music
+$ id3fsd ~/music ~/tags
+
+You may need to be in the 'fuse' group, or be root.
+
+For more details see the man pages for id3fsd(8) and id3fs-index(1).
+
+REPORTING BUGS
+
+Please send comments, bugs and patches to ianb@erislabs.net