From: yomguy <yomguy@parisson.com>
Date: Tue, 22 Nov 2011 00:40:50 +0000 (+0100)
Subject: fix doc
X-Git-Tag: 0.3.2~15
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=c1fccc29931e5b5ac9f819759998790b8c234ee6;p=timeside.git

fix doc
---

diff --git a/INSTALL.rst b/INSTALL.rst
index d35595a..d2abc49 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -42,8 +42,9 @@ Go into the module directory and then install::
     $ cd timeside
     $ python setup.py install
 
-This installs all timeside sub modules as decoders, encoders, analyzers, graphers and
-a few scripts.
+Or, directly from python package directory::
+
+	$ sudo pip install timeside
 
 
 3. Use TimeSide
@@ -103,7 +104,7 @@ For example, a normalization and a waveform, from a python shell::
 >>> decoder  =  timeside.decoder.FileDecoder('source.wav')
 >>> grapher  =  timeside.grapher.Waveform()
 >>> analyzer =  timeside.analyzer.MaxLevel()
->>> encoder  =  timeside.encoder.WavEncoder('output.wav')
+>>> encoder  =  timeside.encoder.Mp3Encoder('output.mp3')
 >>> (decoder | grapher | analyzer | encoder).run()
 >>> grapher.render(output='image.png')
 >>> print 'Level:', analyzer.result()
diff --git a/README.rst b/README.rst
index 4efe8e6..991fb7a 100644
--- a/README.rst
+++ b/README.rst
@@ -1,12 +1,14 @@
-======
-README
-======
+=====================================
+TimeSide : open web audio components
+=====================================
 
 TimeSide is a set of client and server side components for audio-enabling web sites and applications.
+
 It includes a powerful DHTML-based interactive player, with support for time-marking.
 The server side components provide generic APIs for easy transcoding, metadata embedding,
 sound visualization and audio analysis.
 
+
 Platforms
 =========
 
@@ -14,35 +16,49 @@ TimeSide is intended to work on all Unix / Linux platforms.
 MacOS X and Windows versions will soon be explorated.
 
 
+Install and usage
+==================
+
+See INSTALL.rst
+
+
 Dependencies
 ============
 
-For TimeSide Core::
+For TimeSide Core:
+
+  * python (>= 2.4)
+  * python-xml
+  * python-mutagen
+  * python-imaging (>= 1.1.6)
+  * python-numpy
+  * python-setuptools
+  * python-gst0.10
+  * gstreamer0.10-plugins-base,
+  * gstreamer0.10-plugins-fluendo-mp3
+  * gstreamer0.10-plugins-good
+
+For TimeSide UI (optional):
 
-    python (>= 2.4), python-xml, python-mutagen, python-imaging (>= 1.1.6),python-numpy,
-    python-setuptools (>= 0.6b3), python-gst0.10, gstreamer0.10-plugins-base,
-    gstreamer0.10-plugins-fluendo-mp3, gstreamer0.10-plugins-good
+ * 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/README
 
-For TimeSide UI (optional)::
 
-    * 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/README
+Examples
+========
+
+See http://code.google.com/p/timeside/
 
 
 Copyright
 =========
 
 Copyright (c) 2006, 2011 Parisson SARL (parisson.com),
-Copyright (c) 2006, 2010 Samalyse SARL (samalyse.com),
 All rights reserved.
 
-Authors::
-
-    Guillaume Pellerin <yomguy@parisson.com>
-    Olivier Guilyardi  <olivier@samalyse.com>
-    Paul Brossier      <piem@piem.org>
+Copyright (c) 2006, 2010 Samalyse SARL (samalyse.com)
 
 
 License
@@ -61,12 +77,6 @@ GNU General Public License for more details.
 See LICENSE for more details.
 
 
-Install
-=======
-
-See INSTALL for full details.
-
-
 Contact and Informations
 ========================