From 7f82f81a23bb5a5e610f1f1c147e6599238c76d4 Mon Sep 17 00:00:00 2001
From: Paul Brossier <piem@piem.org>
Date: Fri, 22 Jul 2016 22:14:00 +0200
Subject: [PATCH] python/README.md: update (closes #2)

---
 python/README.md | 100 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 68 insertions(+), 32 deletions(-)

diff --git a/python/README.md b/python/README.md
index d28b7ea5..7ee0fa4c 100644
--- a/python/README.md
+++ b/python/README.md
@@ -3,8 +3,70 @@ Python aubio module
 
 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
+------------------------
+
+Some examples are available in the `python/demos` directory. These scripts are
+small programs written in python and using python-aubio.
+
+For instance, `demo_source.py` reads a media file.
+
+    $ ./python/demos/demo_source.py /path/to/sound/sample.wav
+
+and `demo_timestretch_online.py` stretches the original file into a new one:
+
+    $ ./python/demo/demo_timestretch_online.py loop.wav stretched_loop.wav 0.92`
+
+Note: you might need to install additional modules to run some of the demos.
+Some demos use [matplotlib](http://matplotlib.org/) to draw plots, others use
+[PySoundCard](https://github.com/bastibe/PySoundCard) to play and record
+sounds.
+
+Testing the Python module
+-------------------------
+
+To run the all the python tests, use the script:
+
+    $ ./python/tests/run_all_tests
+
+Each test script can also be called one at a time. For instance:
+
+    $ ./python/tests/test_note2midi.py -v
+
+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).
@@ -12,12 +74,14 @@ API Reference Manual] (http://docs.python.org/c-api/index.html) and the
 Compiling python aubio
 ----------------------
 
-After libaubio has been build successfully, and provided Python development
-headers and numpy can be found on your system, you should be able to build the
-aubio Python module:
+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
@@ -29,36 +93,8 @@ To install the Python module:
 
     $ ./setup.py install
 
-Using the Python module
------------------------
-
-Once the aubio library and the Python module are installed, you will be able to
-import the aubio module:
-
-    $ python
-    [...]
-    >>> import aubio
-    >>>
-
 Alternatively, you may want to use the Python module without installing it by
-setting PYTHONPATH:
+setting your PYTHONPATH, for instance as follows:
 
     $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
 
-Testing the Python module
--------------------------
-
-Once both the C library and the Python module have been built correctly, and
-after you have installed them (or setting the environment variable correctly),
-you should be able to run the tests:
-
-    $ ./tests/run_all_tests
-
-And to try out the demos:
-
-    $ ./demos/demo_source.py /path/to/sound/sample.wav
-
-You need to install additional modules to run some of the demos. For
-instance, several demos use [matplotlib](http://matplotlib.org/) to draw plots.
-Some more demos use [PySoundCard](https://github.com/bastibe/PySoundCard) to
-play and record sounds.
-- 
2.11.0