From: yomguy <yomguy@parisson.com>
Date: Tue, 22 Nov 2011 01:17:35 +0000 (+0100)
Subject: fix docs
X-Git-Tag: 0.3.2~9
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=9d33ac5d2c0240a784a71b153c312cee92e13c05;p=timeside.git

fix docs
---

diff --git a/README.rst b/README.rst
index cb5c69c..c3c6552 100644
--- a/README.rst
+++ b/README.rst
@@ -27,8 +27,6 @@ See INSTALL.rst
 Dependencies
 ============
 
-For TimeSide core:
-
   * python (>= 2.4)
   * python-xml
   * python-mutagen
@@ -40,14 +38,35 @@ For TimeSide core:
   * gstreamer0.10-plugins-fluendo-mp3
   * gstreamer0.10-plugins-good
 
-For TimeSide UI (optional):
+
+Provides
+==========
 
  * SoundManager 2 >= 2.91 (http://www.schillmania.com/projects/soundmanager2)
  * jQuery => 1.2.6 (http://www.jquery.com)
  * jsGraphics => 3.03 (http://www.walterzorn.com/jsgraphics/jsgraphics_e.htm)
- 
- * See TimeSide UI integration guide (http://code.google.com/p/timeside/wiki/UiGuide)
- * See timeside/ui/README
+
+
+High level audio process pipes
+===============================
+
+For example::
+
+>>> import timeside
+
+>>> decoder  =  timeside.decoder.FileDecoder('source.wav')
+>>> grapher  =  timeside.grapher.Waveform()
+>>> analyzer =  timeside.analyzer.MaxLevel()
+>>> encoder  =  timeside.encoder.Mp3Encoder('output.mp3')
+>>> (decoder | grapher | analyzer | encoder).run()
+>>> grapher.render(output='image.png')
+>>> print 'Level:', analyzer.result()
+
+
+UI Integration
+===============
+
+See TimeSide UI integration guide: http://code.google.com/p/timeside/wiki/UiGuide
 
 
 Examples
@@ -86,7 +105,7 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
-See /LICENSE for more details.
+See LICENSE for more details.
 
 
 Contact and Informations
diff --git a/timeside/ui/README b/timeside/ui/README
deleted file mode 100644
index 22e0c7b..0000000
--- a/timeside/ui/README
+++ /dev/null
@@ -1,26 +0,0 @@
-===============================
-TimeSide - Web Audio Components
-===============================
-
-Please refer to http://code.google.com/p/timeside/wiki/UiGuide for an exhaustive guide
-
-TimeSide UI Dependencies
-========================
-
-* SoundManager 2 >= 2.97 : http://www.schillmania.com/projects/soundmanager2
-* jQuery => 1.6 : http://www.jquery.com
-* Raphael (ADDED AUTOMATICALLY, DO NOT ADD YOURSELF) => 1.52 http://raphaeljs.com/
-
-Licensing
-=========
-
-Copyright (c) 2008-2009 Samalyse
-Copyright (c) 2011 Riccardo Zaccarelli
-Copyright (c) 2009-2011 Parisson SARL
-
-Authors: Riccardo Zaccarelli <riccardo.zaccarelli gmail.com>
-         Olivier Guilyardi <olivier samalyse com>
-
-TimeSide is released under the terms of the GNU General Public License 
-version 2. Please see the LICENSE file for details.
-
diff --git a/timeside/ui/README.rst b/timeside/ui/README.rst
new file mode 100644
index 0000000..f6bddbb
--- /dev/null
+++ b/timeside/ui/README.rst
@@ -0,0 +1,26 @@
+===================
+TimeSide UI 
+===================
+
+Please refer to http://code.google.com/p/timeside/wiki/UiGuide for an exhaustive guide
+
+Provides
+=========
+
+* SoundManager 2 >= 2.97 : http://www.schillmania.com/projects/soundmanager2
+* jQuery => 1.6 : http://www.jquery.com
+* Raphael (ADDED AUTOMATICALLY, DO NOT ADD YOURSELF) => 1.52 http://raphaeljs.com/
+
+
+Licensing
+=========
+
+Copyright (c) 2009-2011 Parisson SARL
+Copyright (c) 2008-2009 Samalyse
+Copyright (c) 2011 Riccardo Zaccarelli
+
+Authors: Riccardo Zaccarelli <riccardo.zaccarelli gmail.com>
+         Olivier Guilyardi <olivier samalyse com>
+
+TimeSide is released under the terms of the GNU General Public License 
+version 2. Please see the LICENSE file for details.