README: add note about waf
[pd-aubio.git] / README
1 pd-aubio contains various externals for PureData based on the aubio library.
2
3 For more information, see:
4   - aubio homepage: http://aubio.org
5   - puredata homepage: http://puredata.info
6
7 Building
8 --------
9
10 To build everything, run the usual:
11
12   $ ./configure && make 
13
14 Alternatively, you can use waf. For instance, to build against aubio installed
15 in /var/tmp/aubio:
16
17   $ PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig waf \
18       distclean configure build install --prefix=/var/tmp/aubio 
19
20 Installing
21 ----------
22
23 To install the aubio external for puredata on your system, run the following as
24 root:
25
26   # make install
27
28 Running
29 -------
30
31 To load the external, start pd as follows
32
33   $ pd -lib aubio
34
35 If you want to use the external without installing it, the above command should
36 work as expected from the pd-aubio source directory. If needed, set your
37 LD_LIBRARY_PATH to include the path to the aubio library.