Changeset a96413e for doc

Timestamp:

Aug 27, 2016, 12:42:32 AM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

e523483

Parents:

d44763f

Message:

doc/index.rst: clean up and add some external links

File:

• doc/index.rst (modified) (2 diffs)

doc/index.rst

@@ -10 +10 @@
 performing pitch detection, tapping the beat and producing midi streams from
 live audio.
+
+Features
+========
 
 aubio provide several algorithms and routines, including:
@@ -28 +31 @@
 found in the results.
 
-Python module
--------------
-
-A python module to access the library functions is also provided. Please see
-the file ``python/README`` for more information on how to use it.
-
-Examples tools
---------------
-
-A few simple command line tools are included along with the library:
-
- - ``aubioonset`` outputs the time stamp of detected note onsets
- - ``aubiopitch`` attempts to identify a fundamental frequency, or pitch, for
-   each frame of the input sound
- - ``aubiomfcc`` computes Mel-frequency Cepstrum Coefficients
- - ``aubiotrack`` outputs the time stamp of detected beats
- - ``aubionotes`` emits midi-like notes, with an onset, a pitch, and a duration
- - ``aubioquiet`` extracts quiet and loud regions
-
-Additionally, the python module comes with the following script:
-
- - ``aubiocut`` slices sound files at onset or beat timestamps
-
-C API basics
-------------
-
-The library is written in C and is optimised for speed and portability.
-
-The C API is designed in the following way:
-
-.. code-block:: c
-
-    aubio_something_t * new_aubio_something(void * args);
-    audio_something_do(aubio_something_t * t, void * args);
-    smpl_t aubio_something_get_a_parameter(aubio_something_t * t);
-    uint_t aubio_something_set_a_parameter(aubio_something_t * t, smpl_t a_parameter);
-    void del_aubio_something(aubio_something_t * t);
-
-For performance and real-time operation, no memory allocation or freeing take
-place in the ``_do`` methods. Instead, memory allocation should always take place
-in the ``new_`` methods, whereas free operations are done in the ``del_`` methods.
-
-.. code-block:: bash
-
-    ./waf configure
-    ./waf build
-    sudo ./waf install
-
-aubio compiles on Linux, Mac OS X, Cygwin, and iPhone.
-
-Documentation
--------------
-
-- Manual pages: http://aubio.org/documentation
-- API documentation: http://aubio.org/doc/latest/
-
-Contribute
-----------
-
-- Issue Tracker: https://github.com/piem/aubio/issues
-- Source Code: https://github.com/piem/aubio
-
-Contact info
-------------
-
-The home page of this project can be found at: http://aubio.org/
-
-Questions, comments, suggestions, and contributions are welcome. Use the
-mailing list: <aubio-user@aubio.org>.
-
-To subscribe to the list, use the mailman form:
-http://lists.aubio.org/listinfo/aubio-user/
-
-Alternatively, feel free to contact directly the author.
-
-
-Contents
---------
+Content
+=======
 
 .. toctree::
    :maxdepth: 2
 
-   download
    installing
+   cli
    python_module
+
+Project pages
+=============
+
+* `Project homepage`_: https://aubio.org
+* `aubio on github`_: https://github.com/aubio/aubio
+* `aubio on pypi`_: https://pypi.python.org/pypi/aubio
+* `API documentation`_: https://aubio.org/doc/latest/
+* `Mailing lists`_: https://lists.aubio.org
+
+.. _Project homepage: https://aubio.org
+.. _aubio on github: https://github.com/aubio/aubio
+.. _aubio on pypi: https://pypi.python.org/pypi/aubio
+.. _api documentation: https://aubio.org/doc/latest/
+.. _Mailing lists: https://lists.aubio.org/
+
+Current status
+==============
+
+.. image:: https://travis-ci.org/aubio/aubio.svg?branch=master
+   :target: https://travis-ci.org/aubio/aubio
+   :alt: Travis build status
+
+.. image:: https://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true
+   :target: https://ci.appveyor.com/project/piem/aubio/
+   :alt: Appveyor build status
+
+.. image:: https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat
+   :target: https://landscape.io/github/aubio/aubio/master
+   :alt: Landscape code health
+
+.. image:: http://readthedocs.org/projects/aubio/badge/?version=latest
+   :target: http://aubio.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation status
+
+* `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_
+* `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_
+* `ReadTheDocs documentation <http://aubio.readthedocs.io/en/latest/>`_
+
+Copyright and License
+=====================
+
+Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
+
+aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
+<http://www.opensource.org/docs/definition.php>`_ software; **you** can
+redistribute it and/or modify it under the terms of the `GNU
+<http://www.gnu.org/>`_ `General Public License
+<https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
+Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
+option) any later version.
+
+.. Note:: aubio is not MIT or BSD licensed. Contact the author if you need it
+  in your commercial product.