help/aubiotss~-help.pd: improve documentation
[pd-aubio.git] / README
diff --git a/README b/README
index 601f6ef..a1e3873 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-pd-aubio contains various externals for PureData based on the aubio library.
+pd-aubio contains various externals for PureData using the aubio library.
 
 For more information, see:
   - aubio homepage: http://aubio.org
@@ -7,12 +7,13 @@ For more information, see:
 Building
 --------
 
-To build everything, run the usual:
+pd-aubio uses waf. To configure and build it, run:
 
-  $ ./configure && make 
+  $ ./waf configure build
 
-Alternatively, you can use waf. For instance, to build against aubio installed
-in /var/tmp/aubio:
+If you have aubio installed in an unusual location, just set your
+PKG_CONFIG_PATH accordingly. For instance, to build against aubio installed in
+/var/tmp/aubio:
 
   $ PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig waf \
       distclean configure build install --prefix=/var/tmp/aubio 
@@ -32,6 +33,8 @@ To load the external, start pd as follows
 
   $ pd -lib aubio
 
+Alternatively, you can create an object [aubio] to initialize the external.
+
 If you want to use the external without installing it, the above command should
 work as expected from the pd-aubio source directory. If needed, set your
 LD_LIBRARY_PATH to include the path to the aubio library.