From: Guillaume Pellerin <yomguy@parisson.com>
Date: Sat, 18 Dec 2010 16:12:52 +0000 (+0000)
Subject: update docs
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=42382d9e42309ef15917084c9f185b7657ae9bcf;p=deefuzzer.git

update docs
---

diff --git a/INSTALL b/INSTALL
index a224742..1a1c24d 100644
--- a/INSTALL
+++ b/INSTALL
@@ -28,7 +28,7 @@ Install
 
 To install the DeeFuzzer, go to the main deefuzzer app directory, for example::
     
-    cd deefuzzer-0.4.3
+    cd deefuzzer-0.5.0
     
 and run the python installer::
     
@@ -54,7 +54,7 @@ Get and install python-twitter (>= 0.9dev)::
     sudo python setup.py install
 
 As Twitter access requires oauth keys since 07/2010, you need to get your own access token key pair.
-Please run the dedicated script to do this::
+Please run the dedicated script to do this from the main deefuzzer app directory::
     
     python tools/get_access_token.py
     
diff --git a/README b/README
index d5baf32..1b5cbd1 100644
--- a/README
+++ b/README
@@ -18,7 +18,7 @@ Here are the main features of the deefuzzer:
  * M3U playlist generator
  * Recursive, random (shuffled) or pre-defined playlists
  * Multi-threaded architecture : multiple station streaming with one config file
- * Auto Twitter posting of the current playing tracks
+ * Auto Twitter posting of the current playing and new tracks
  * Jingling between main tracks
  * OSC controller : control the main functions from a distant terminal
  * Station relaying : stream other stations like *LIVE* sessions !
@@ -49,11 +49,11 @@ Usage : deefuzzer CONFIGFILE
 
 where CONFIGFILE is the path for a XML config file. For example::
 
-    deefuzzer example/myfuzz.xml
+    deefuzzer example/deefuzzer.xml
 
 To make the deefuzzer act as a deamon, just play it in the background::
 
-    deefuzzer example/myfuzz.xml &
+    deefuzzer example/deefuzzer.xml &
 
 Note that you must edit the config file with right parameters before playing.
 You can find an example for a draft XML file in the directory "example/" of this
@@ -66,17 +66,13 @@ BE CAREFULL : at the moment, the multi-threaded implementation of deefuzzer inst
 avoids shutting down the streams with CTRL+C... You have to kill them manually,
 after a CTRL+Z, making this::
 
-    kill -9 PROCESS_ID
-
-or::
-
     pkill -9 deefuzzer
 
 
 XML Configuration
 =================
 
-See example/myfuzz.xml in a text editor.
+See example/deefuzz_doc.xml in a text editor.
 The inline comments should help you to configure your stations.