From a6b7e1080d5b9c5e156821f4c673aa46cf97ebf1 Mon Sep 17 00:00:00 2001 From: Guillaume Pellerin Date: Wed, 28 Sep 2011 09:52:09 +0000 Subject: [PATCH] update doc --- License.txt => LICENSE.txt | 0 README.txt | 29 +++++---- deefuzzer/__init__.py | 2 +- example/deefuzzer_mp3_ogg.xml | 113 ++++++++++++++++++++++++++++++++++ setup.py | 2 +- 5 files changed, 129 insertions(+), 17 deletions(-) rename License.txt => LICENSE.txt (100%) create mode 100644 example/deefuzzer_mp3_ogg.xml diff --git a/License.txt b/LICENSE.txt similarity index 100% rename from License.txt rename to LICENSE.txt diff --git a/README.txt b/README.txt index 0aca39b..b7fe5ca 100644 --- a/README.txt +++ b/README.txt @@ -2,7 +2,7 @@ Introduction ============ -DeeFuzzer is a new light and instant software made for streaming audio and video over internet. +DeeFuzzer is a free, light and instant software made for streaming audio and video over internet. It is dedicated to people who wants to create playlisted web radios or web TVs with rich media contents including some metadata. Here are the main features of the deefuzzer: @@ -19,9 +19,10 @@ Here are the main features of the deefuzzer: * Station relaying : stream other stations like *LIVE* sessions ! * Very light and optimized streaming process -It is neccessary to provide a config file which sets all needed parameters -Please see example/myfuzz.xml for an example. +It is onlu neccessary to provide a config file which sets all needed parameters. +Please see example/deefuzzer.xml for an example. +Because our aim is to get DeeFuzzer as light as possible it is NOT capable of re-encoding or transcoding media files. Installation ============ @@ -38,7 +39,8 @@ or:: To install the DeeFuzzer from sources, go to the main deefuzzer app directory, for example:: - cd deefuzzer-0.5.0 + tar xzf deefuzzer-0.6.tar.gz + cd deefuzzer-0.6 and run:: @@ -50,9 +52,9 @@ For more informations, see http://svn.parisson.org/deefuzzer/ License ======= -This software is licensed as described in the file LICENSE, which +This software is licensed as described in the file LICENSE.txt, which you should have received as part of this distribution. The terms -are also available at http://svn.parisson.org/deefuzzer/DeeFuzzerLicense +are also available at http://svn.parisson.org/deefuzzer/wiki/DeeFuzzerLicense Usage @@ -76,7 +78,7 @@ Since 0.3, deefuzzer doesn't print anything into the shell, then a right p is needed in the XML config file. BE CAREFULL : at the moment, the multi-threaded implementation of deefuzzer instances -avoids shutting down the streams with CTRL+C... You have to kill them manually, +avoids shutting down the process with a CTRL+C. You have to kill them manually, after a CTRL+Z, making this:: pkill -9 deefuzzer @@ -88,13 +90,16 @@ XML Configuration See example/deefuzz_doc.xml in a text editor. The inline comments should help you to configure your stations. +For a short MP3 example, see example/deefuzzer.xml. +For a mixed MP3 + OGG example, see example/deefuzzer_mp3_ogg.xml. + OSC Control =========== We can now control some functions of the deefuzzer with external commands -coming from an OSC client. These are accessible only if the "control" tag is -set up in the config file (see example/deefuzzer.xml again...). +coming from an OSC client. These are accessible only if the tag is +set up to "1" in the config file (see example/deefuzzer.xml again...). Next track:: @@ -131,12 +136,6 @@ Author Guillaume Pellerin -License -======= - -See COPYING - - Aknowledgements =============== diff --git a/deefuzzer/__init__.py b/deefuzzer/__init__.py index 6ad2260..7044ccc 100644 --- a/deefuzzer/__init__.py +++ b/deefuzzer/__init__.py @@ -1,4 +1,4 @@ from core import * from tools import * -__version__ = '0.6' +__version__ = '0.6.1' diff --git a/example/deefuzzer_mp3_ogg.xml b/example/deefuzzer_mp3_ogg.xml new file mode 100644 index 0000000..2161f3c --- /dev/null +++ b/example/deefuzzer_mp3_ogg.xml @@ -0,0 +1,113 @@ + + /path/to/log/mystation.log + /path/to/m3u/mystation.m3u + + + + my_station_mp3 + My best funky station + My personal best funky playlist ever ! + http://mydomain.com + Various Funk Groove + + + mydomain.com + 8000 + icecast_source_password + 1 + + + /home/me/music/MP3 + mp3 + 192 + 7 + 44100 + 2 + 1 + + + /path/to/rss/ + 1 + + + 0 + your access token key + your access token secret key + bla bla + + + 0 + /home/me/jingles/MP3 + 1 + + + 0 + 1234 + + + 0 + http://anotherdomain.com:8000/stream.mp3 + Me + + + 0 + /path/to/archives + + + + + + my_station_ogg + My best funky station + My personal best funky playlist ever ! + http://mydomain.com + Various Funk Groove + + + mydomain.com + 8000 + icecast_source_password + 1 + + + /home/me/music/OGG + ogg + 192 + 7 + 44100 + 2 + 1 + + + /path/to/rss/ + 1 + + + 0 + your access token key + your access token secret key + bla bla + + + 0 + /home/me/jingles/OGG + 1 + + + 0 + 1234 + + + 0 + http://anotherdomain.com:8000/stream.mp3 + Me + + + 0 + /path/to/archives + + + + + + diff --git a/setup.py b/setup.py index 2f70041..112e0ee 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ import os -__version__ = '0.6' +__version__ = '0.6.1' __author__ = 'yomguy@parisson.com' # The base package metadata to be used by both distutils and setuptools -- 2.39.5