From: Guillaume Pellerin <yomguy@parisson.com>
Date: Fri, 30 Jan 2015 23:29:29 +0000 (+0100)
Subject: cleanup README (pushing some part in the wiki)
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=6b5a33c9f3ca187f5379d58a40611457cd658a93;p=deefuzzer.git

cleanup README (pushing some part in the wiki)
---

diff --git a/README.rst b/README.rst
index 1dc5f91..8a19bab 100644
--- a/README.rst
+++ b/README.rst
@@ -127,34 +127,19 @@ To make the deefuzzer act as a deamon, just play it in the background::
     deefuzzer example/deefuzzer.yaml &
 
 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 "example" directory of the source code.
 
-WARNING: because we need the DeeFuzzer to be a very stable streaming process with multiple channel management,
-the multi-threaded implementation of deefuzzer instances avoids shutting down the process with a CTRL+C.
-You have to kill them manually, after a CTRL+Z, making this::
 
-    pkill -9 deefuzzer
-
-or, more specificially::
-
-    pkill -9 -f "deefuzzer example/deefuzzer.yaml"
-
-
-doucmentation
+Documentation
 =============
 
-Some examples of markup configuration files:
-
- * `generic and documented XML <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer_doc.xml>`_
- * `generic XML for testing <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer.xml>`_
- * `OGG Vorbis and MP3 together <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer_mp3_ogg.xml>`_
- * `generic YAML <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer.yaml>`_
-
-
-API
-===
-
-http://files.parisson.com/doc/deefuzzer/
+ * `Wiki <https://github.com/yomguy/DeeFuzzer/wiki>`_
+ * `API <http://files.parisson.com/doc/deefuzzer/>`_ 
+ * `Documented XML configuration <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer_doc.xml>`_
+ * Configuration examples:
+     
+     * `Dummy XML for testing <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer.xml>`_
+     * `OGG Vorbis and MP3 together <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer_mp3_ogg.xml>`_
+     * `Generic YAML <https://github.com/yomguy/DeeFuzzer/blob/master/example/deefuzzer.yaml>`_
 
 
 Development