From: Guillaume Pellerin <yomguy@parisson.com>
Date: Tue, 15 Oct 2013 21:20:17 +0000 (+0200)
Subject: update sphinx doc & index, parse it to README.rst
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=45e6b0f0f87d13aa5cff5f79509a516d7f070103;p=timeside-diadems.git

update sphinx doc & index, parse it to README.rst
---

diff --git a/README.rst b/README.rst
index 9a80d57..a2d7c21 100644
--- a/README.rst
+++ b/README.rst
@@ -60,7 +60,6 @@ Available plugins
      - XML
      - HDF5
 
-
 News
 =====
 
@@ -84,7 +83,7 @@ News
 
 0.4.4
 
- * Only minor setup bugfixes
+ * Only setup bugfixes
  * Last compatible version with Python 2.6
  * Next version 0.5 will integrate serious new analyzer features (aubio, yaafe and more)
 
@@ -139,7 +138,6 @@ News
  * duration analysis goes to decoder.duration property
  * bugfixes
 
-
 Dive in
 ========
 
@@ -162,22 +160,34 @@ get the results::
 
 `More examples <http://code.google.com/p/timeside/wiki/PythonApi>`_
 
-
 Install
 =======
 
 TimeSide needs some other python modules to run. The following methods explain how to install all dependencies on various Linux based systems.
 
-On Debian, Ubuntu, etc::
+On Debian, Ubuntu, etc:
+
+.. code-block:: bash
 
  $ echo "deb http://debian.parisson.com/debian/ stable main" | sudo tee -a /etc/apt/sources.list
  $ sudo apt-get update
  $ sudo apt-get install python-timeside
 
+On Fedora and Red-Hat:
+
+.. code-block:: bash
+
+ $ sudo yum install gcc python python-devel gstreamer pygobject2 gstreamer-python  \
+                   gstreamer gstreamer-plugins-bad-free gstreamer-plugins-bad-free-extras \
+                   gstreamer-plugins-base gstreamer-plugins-good
+
+ $ sudo pip install timeside
+
 On other system, you'll need to install the Gstreamer framework, some librairies and some python modules (see #Dependencies) ::
 
  $ sudo pip install timeside
 
+
 Dependencies
 ============
 
@@ -185,6 +195,14 @@ python (>=2.7), python-setuptools, python-gst0.10, gstreamer0.10-plugins-good, g
 gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py
 
 
+Platforms
+==========
+
+The TimeSide engine is intended to work on all Unix / Linux platforms.
+MacOS X and Windows versions will soon be explorated.
+The player should work on any modern HTML5 enabled browser.
+Flash is needed for MP3 if the browser doesn't support it.
+
 Extensible HTML5 User Interface
 ================================
 
@@ -199,34 +217,12 @@ The detailed documentation to extend the player:
 
  * https://github.com/yomguy/TimeSide/wiki/Ui-Guide
 
-
-Documentation
-==============
-
-Engine API : http://code.google.com/p/timeside/source/browse/trunk/timeside/api.py
-
-
-Related projects
-=================
-
-TimeSide has emerged in 2010 from the `Telemeta project <http://telemeta.org>`_ which develops a free and open source web audio CMS.
-
-Some decoders and encoders depend on the great `GStreamer framework <http://gstreamer.freedesktop.org/>`_.
-
-
-Platforms
-=========
-
-The TimeSide engine is intended to work on all Unix / Linux platforms.
-MacOS X and Windows versions will soon be explorated.
-The player should work on any modern HTML5 enabled browser.
-Flash is needed for MP3 if the browser doesn't support it.
-
-
 Development
 ===========
 
-For versions >=0.5 on Debian Stable 7.0 Wheezy::
+For versions >=0.5 on Debian Stable 7.0 Wheezy:
+
+.. code-block:: bash
 
  $ echo "deb http://debian.parisson.com/debian/ stable main" | sudo tee -a /etc/apt/sources.list
  $ echo "deb-src http://debian.parisson.com/debian/ stable main" | sudo tee -a /etc/apt/sources.list
@@ -240,16 +236,12 @@ For versions >=0.5 on Debian Stable 7.0 Wheezy::
  $ export PYTHONPATH=$PYTHONPATH:`pwd`
  $ python tests/run_all_tests
 
+Related projects
+=================
 
-API / Documentation
-====================
-
-The *source code*, the API and some slides:
-
- * https://github.com/yomguy/TimeSide
- * http://files.parisson.com/api/timeside/
- * http://files.parisson.com/timeside/timeside/doc/timeside_slides.html
+TimeSide has emerged in 2010 from the `Telemeta project <http://telemeta.org>`_ which develops a free and open source web audio CMS.
 
+Some decoders and encoders depend on the great `GStreamer framework <http://gstreamer.freedesktop.org/>`_.
 
 Copyrights
 ==========