From 6b5a33c9f3ca187f5379d58a40611457cd658a93 Mon Sep 17 00:00:00 2001 From: Guillaume Pellerin Date: Sat, 31 Jan 2015 00:29:29 +0100 Subject: [PATCH] cleanup README (pushing some part in the wiki) --- README.rst | 33 +++++++++------------------------ 1 file changed, 9 insertions(+), 24 deletions(-) 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 `_ - * `generic XML for testing `_ - * `OGG Vorbis and MP3 together `_ - * `generic YAML `_ - - -API -=== - -http://files.parisson.com/doc/deefuzzer/ + * `Wiki `_ + * `API `_ + * `Documented XML configuration `_ + * Configuration examples: + + * `Dummy XML for testing `_ + * `OGG Vorbis and MP3 together `_ + * `Generic YAML `_ Development -- 2.39.5