From: Guillaume Pellerin Date: Fri, 16 May 2014 07:04:12 +0000 (+0200) Subject: fix doc X-Git-Tag: 0.5.5~1^2~22^2 X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=f24c535119035738e6a5b4ed7ffba8d457078e57;p=timeside.git fix doc --- diff --git a/MANIFEST.in b/MANIFEST.in index 48da8f0..bdcc23a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,7 +3,7 @@ include LICENSE include README.rst include requirements.txt recursive-include doc * -recursive-include timeside/static * +recursive-include timeside/player/static * recursive-include tests * recursive-exclude * *.pyc recursive-exclude * *.swp diff --git a/README.rst b/README.rst index 84b9384..c0f6764 100644 --- a/README.rst +++ b/README.rst @@ -319,7 +319,7 @@ Outside Debian:: djangorestframework, django-extensions -Shell Interface +Shell interface ================ Of course, TimeSide can be used in any python environment. But, a shell script is also provided to enable preset based and recursive processing through your command line interface:: @@ -354,8 +354,8 @@ Of course, TimeSide can be used in any python environment. But, a shell script i -o , --ouput-directory= output directory -Web Interface -============== +Web player interface +===================== TimeSide comes with a smart and pure **HTML5** audio player. diff --git a/doc/source/install.rst b/doc/source/install.rst index 09daef6..357507e 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -6,7 +6,7 @@ MacOS X and Windows versions will soon be explorated. TimeSide needs some other python modules and other compiled librairies like GStreamer, Aubio and Yaafe to run. So, before installing the module, you'll need to install dependencies before. -For Debian based distributions, we provide a safe repository to install all in one line: +For Debian based distributions, we provide a safe repository to install all in 3 lines: .. code-block:: bash @@ -14,7 +14,7 @@ For Debian based distributions, we provide a safe repository to install all in o $ sudo apt-get update $ sudo apt-get install python-timeside -On other Linux platforms, you can also install all dependencies (see list bellow to find your equivalent package in your distribution) and then use pip:: +On other Linux platforms, you can also install all binary dependencies (see list bellow to find all equivalent packages for your distribution) and then use pip:: $ sudo pip install timeside @@ -26,9 +26,7 @@ Dependencies Inside Debian:: -python (>=2.7), python-setuptools, python-gst0.10, gstreamer0.10-plugins-good, gstreamer0.10-gnonlin, -gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py, -python-scipy, python-matplotlib, python-matplotlib, python-django, python-django-south +python (>=2.7), python-setuptools, python-gst0.10, gstreamer0.10-plugins-good, gstreamer0.10-plugins-bad, gstreamer0.10-gnonlin, gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py, python-scipy, python-matplotlib, python-matplotlib, python-django, python-django-south Outside Debian:: diff --git a/doc/source/ui.rst b/doc/source/ui.rst index fa08405..0429d5b 100644 --- a/doc/source/ui.rst +++ b/doc/source/ui.rst @@ -1,4 +1,4 @@ -Shell Interface +Shell interface ================ Of course, TimeSide can be used in any python environment. But, a shell script is also provided to enable preset based and recursive processing through your command line interface:: @@ -33,8 +33,8 @@ Of course, TimeSide can be used in any python environment. But, a shell script i -o , --ouput-directory= output directory -Web Interface -============== +Web player interface +===================== TimeSide comes with a smart and pure **HTML5** audio player. @@ -76,6 +76,6 @@ A sandbox is provide in timeside/server/sandbox and you can initialize it and te and browse http://localhost:8000/api/ -This server is not currently connected to the player but this will be done soon so that TimeSide can provide a completely autonomous service on the web (the server side as well as the server side). +This server is not currently connected to the player but this will be done soon so that TimeSide can provide a complete autonomous service on the web (a server side and a client side).