summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKjetil Ørbekk <orbekk@pvv.ntnu.no>2008-08-14 16:40:10 +0200
committerKjetil Ørbekk <orbekk@pvv.ntnu.no>2008-08-14 16:40:10 +0200
commit4519d5f911ef98f1317bb6307648610ea15586bd (patch)
tree9c7d029f1c681cf1fe16d2ebffd0970b261fd91d
parentf91f023da84a6ff163f3c9933ff30c100f14910a (diff)
- Added Usage information to README
-rwxr-xr-xREADME23
1 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
index 0010ca7..7cdad7e 100755
--- a/README
+++ b/README
@@ -1,12 +1,35 @@
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ musicfs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
musicfs is a FUSE module implementing a media filesystem in
userland. The purpose of musicfs is to provide filesystem hierarchy
based on id3 tags of mp3-files.
+
+Usage
+~~~~~
+1. Compile:
+
+$ make
+
+2. Initialise the database:
+
+$ sqlite3 music.db < dbschema.sql
+
+3. Run:
+
+$ ./musicfs -d <music path> <mount path>
+
+On my computer, it only behaves correctly in debug mode (-d) due to a
+bug of some kind. I don't really know why :'(
+
+
Dependencies
~~~~~~~~~~~~
- taglib 1.5
- FUSE v.2.6?
+
License
~~~~~~~
This program is free software; you can redistribute it and/or modify