Mercurial > hg > auditok
changeset 53:9d626b6dda24
doc update
| author | Amine SEHILI <amine.sehili@gmail.com> |
|---|---|
| date | Fri, 11 Mar 2016 09:49:21 +0100 |
| parents | e5feda498bb6 |
| children | 0304e7e8d155 |
| files | doc/index.rst |
| diffstat | 1 files changed, 4 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- 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 <http://auditok.readthedocs.org/en/latest/>`_. @@ -27,16 +27,17 @@ - `numpy <http://www.numpy.org>`_ : 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` - - -