version 0.37
[FAPG] / README
diff --git a/README b/README
old mode 100755 (executable)
new mode 100644 (file)
index ca5ce57..f180f76
--- a/README
+++ b/README
@@ -1,13 +1,27 @@
-FAPG 0.0 (Fast Audio Playlist Generator)
+FAPG 0.37 (Fast Audio Playlist Generator)
 site: http://royale.zerezo.com/fapg/
 mail: royale@zerezo.com
 
 site: http://royale.zerezo.com/fapg/
 mail: royale@zerezo.com
 
-This is a pre-released version for testing purpose only !
+install:
+make
+make install
 
 
-TODO :
-  - fapg.css
-  - define best "size" for MAX constant...
-  - XML export ? format (DTD) ?
-  - SQL export ? INSERT INTO playlist VALUES (counter,artist,title,time) ?
-  - TXT export ? format ?
-  - support MP3 specials headers (extended & unsynchronisation)...
\ No newline at end of file
+usage:
+fapg [-b|--backslash] [-d|--debug] [-f|--format=m3u|pls|html|rss|pla] [-g|--genre=#:#:...] [-o|--output=/path/to/file.m3u] [-p|--prefix=/the/prefix] [-r|--recursive] [-w|--windows] [-x|--exclude=#:#:...] [-c|--command=<intern|...>] [-s|--stdin] /path/to/mp3/dir1 [/path/to/mp3/dir2 ...]
+- backslash : replace the '/' with '\' in Unix path. 
+- debug : display useful messages if the program fails ;) 
+- format : choose which format of playlist you want to generate (default is m3u). 
+- genre : choose which genres will be included in the generated playlist (default is all). 
+- output : choose the name of the playlist file to generate (default behavior is to display on standart output). 
+- prefix : replace the Unix path with another string (useful to give a Samba path for example). 
+- recursive : recursively read the subdirectories. 
+- windows : replace all Unix characters with Windows characters... 
+- exclude : choose which genres will be excluded in the generated playlist (default is none). 
+- command : external binary or script that produces additional fields for RSS feeds (slow).
+- stdin : read filenames and/or directories from standard input instead of command line.
+
+links :
+http://geek.scorpiorising.ca/scripts.html
+http://id3lib.sourceforge.net/
+http://id3.org/
+http://www.xiph.org/ogg/vorbis/docs.html