shithub: aubio

--- a/python/README.md

+++ b/python/README.md

@@ -3,16 +3,6 @@

 This module wraps the aubio library for Python using the numpy module.

-Using the Python aubio module

------------------------------

-After installing python-aubio, you will be able to import the aubio module:

-    $ python

-    [...]

-    >>> import aubio

-    >>> help(aubio.miditofreq)

 Finding some inspiration

 ------------------------

@@ -47,58 +37,6 @@

 [nose2]: https://github.com/nose-devs/nose2

-Install in a virtualenv

------------------------

-You should be able to install python-aubio directly from the top source

-directory of aubio.

-First, create a virtualenv to hold the required python module:

-    $ virtualenv pyaubio

-    $ source pyaubio/bin/activate

-Now install and build the python extension using:

-    $ pip install .

-Install requirements

---------------------

-Before compiling this module, you must have compiled libaubio.

-A simple way to do this is with pip:

-    $ pip install -r requirements.txt

 For more information about how this module works, please refer to the [Python/C

 API Reference Manual] (http://docs.python.org/c-api/index.html) and the

 [Numpy/C API Reference](http://docs.scipy.org/doc/numpy/reference/c-api.html).

-Compiling python aubio

-----------------------

-To build the aubio Python module, run the following command from the top source

-directory of aubio:

-    $ ./setup.py build

-Note: if libaubio was previously built using waf, the script will use it.

-Otherwise, the entire library will be built inside the python extension.

-To find out more about `setup.py` options:

-    $ ./setup.py --help

-Installing

-----------

-To install the Python module:

-    $ ./setup.py install

-Alternatively, you may want to use the Python module without installing it by

-setting your PYTHONPATH, for instance as follows:

-    $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests