summaryrefslogtreecommitdiff
path: root/README
blob: 07fe6e40cb7da4ed2e8eeb336fbf887d7e051e12 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                              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 2.6
- Sqlite 3


License
~~~~~~~
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

A copy of the license can typically be found in COPYING