# HG changeset patch # User Amine SEHILI # Date 1457686161 -3600 # Node ID 9d626b6dda2409d1b21328e640534aa6c1d6286b # Parent e5feda498bb6c7b7f06ef99d94b5cc6db6ccee82 doc update diff -r e5feda498bb6 -r 9d626b6dda24 doc/index.rst --- a/doc/index.rst Fri Mar 11 09:49:02 2016 +0100 +++ b/doc/index.rst Fri Mar 11 09:49:21 2016 +0100 @@ -8,7 +8,7 @@ :target: http://auditok.readthedocs.org/en/latest/?badge=latest :alt: Documentation Status -**auditok** is an **Audio Activity Detection** tool that can process online data (read from an audio device or from standard input) as well as audio files. It can be used as a command line program and offers an easy to use API. +`auditok` is an **Audio Activity Detection** tool that can process online data (read from an audio device or from standard input) as well as audio files. It can be used as a command line program and offers an easy to use API. The latest version of this documentation can be found at `Readthedocs `_. @@ -27,16 +27,17 @@ - `numpy `_ : required by matplotlib. Also used for math operations instead of standard python if available. -- Optionally, you can use **sox** or **parecord** for data acquisition and feed **auditok** using a pipe. +- Optionally, you can use `sox` or `[p]arecord` for data acquisition and feed `auditok` using a pipe. Installation ------------ +Install with pip: + .. code:: bash sudo pip install auditok - or install the latest version on Github: .. code:: bash @@ -71,6 +72,3 @@ * :ref:`genindex` * :ref:`modindex` * :ref:`search` - - -