fix doc

diff --git a/INSTALL.rst b/INSTALL.rst
deleted file mode 100644 (file)
index bd56d86..0000000
--- a/INSTALL.rst
+++ /dev/null
@@ -1,106 +0,0 @@
-=======================
-Howto Install TimeSide
-=======================
-
-This file describe how to install the TimeSide python package from source.
-
-
-INSTALL
-=======
-
-TimeSide needs some other python modules to run. The following methods explain how to install all dependencies on a Debian based system like Debian, Ubuntu, etc.. On Fedora and Red-Hat you might replace 'apt-get by 'yum', on Gentoo by 'emerge', or any other package manager you like::
-
-    $ sudo apt-get update
-    $ sudo apt-get install python python-pip python-setuptools python-gobject \
-                            python-gst0.10 gstreamer0.10-plugins-base gir1.0-gstreamer-0.10 \
-                            gstreamer0.10-plugins-good gstreamer0.10-plugins-bad \
-                            gobject-introspection
-
-    $ sudo pip install timeside
-
-To get non-free MP3, MP4 or AAC decoding and encoding features, add Debian Multimedia repository and install the modules::
-
-    $ echo "deb http://www.deb-multimedia.org stable main non-free" | sudo tee -a /etc/apt/sources.list
-    $ sudo apt-get update
-    $ apt-get install gstreamer0.10-lame gstreamer0.10-plugins-really-bad
-
-
-3. Use TimeSide
-===============
-
-3.1. Waveform batching
-----------------------
-
-You can use waveform_batch to create some waveforms from a media (audio) directory, type::
-
-    $ waveform_batch /path/to/media_dir /path/to/img_dir
-
-Please use absolute paths. For example::
-
-    $ waveform_batch /home/$user/music/mp3/ /home/$USER/images/
-
-
-To change the color scheme or the size of the waveforms, edit the waveform_batch script::
-
-    $ vi timeside/tools/waveform_batch
-
-And change only the following variables of the GrapherScheme object::
-
-        self.color_scheme = {
-            'waveform': [ # Four (R,G,B) tuples for three main color channels for the spectral centroid method
-                        (173,173,173), (147,149,196), (77,80,138), (108,66,0)
-                        # this is a purple one
-                        ],
-            'spectrogram': [
-                        (0, 0, 0), (58/4,68/4,65/4), (80/2,100/2,153/2), (90,180,100), (224,224,44), (255,60,30), (255,255,255)
-                        ]}
-
-        # Width of the image
-        self.width = 2048
-
-        # Height of the image
-        self.height = 128
-
-        # Background color
-        self.bg_color = (255,255,255)
-
-        # Force computation. By default, the class doesn't overwrite existing image files.
-        self.force = False
-
-Save the script and re-run setup::
-
-    $ python setup.py install
-
-
-3.2. Any other pipe processing !
---------------------------------
-
-For example, a normalization and a waveform, from a python shell::
-
->>> 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()
-
-
-4. TimeSide UI
---------------
-
-See http://code.google.com/p/timeside/wiki/UiGuide
-
-
-5. More informations
-====================
-
-See the website for more examples and information about the TimeSide API:
-
-http://code.google.com/p/timeside/
-
-http://code.google.com/p/timeside/wiki/PythonApi
-
-http://code.google.com/p/timeside/source/browse/trunk/timeside/api.py

diff --git a/README.rst b/README.rst
index 5aac76457dca9694a1ce6de9df444eb0a6277fb9..ff24d79d80189c33660c152c4a6038f1315eaaf1 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -55,9 +55,9 @@ More examples
 Related projects
 =================
 
-TimeSide has emerged in 2010 from the `Telemeta project <http://telemeta.org>`_ which develop a free and open-source web audio CMS.
+TimeSide has emerged in 2010 from the `Telemeta project <http://telemeta.org>`_ which develops a free and open-source web audio CMS.
 
-The time decoder depends on the `GStreamer framework<http://gstreamer.freedesktop.org/>`_.
+The time decoder depends on the great `GStreamer framework <http://gstreamer.freedesktop.org/>`_.
 
 
 APIs
@@ -99,9 +99,7 @@ To get non-free MP3, MP4 or AAC decoding and encoding features, add Debian Multi
 Batching
 =========
 
-TimeSide provides ts-waveforms : a waveform redering batch script.
-
-Usage::
+TimeSide provides *ts-waveforms*, a waveform rendering batch script. Usage::
 
  $ ts-waveforms /path/to/media_dir /path/to/img_dir