help/aubiotss~-help.pd: improve documentation
[pd-aubio.git] / README
1 pd-aubio contains various externals for PureData using 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 pd-aubio uses waf. To configure and build it, run:
11
12   $ ./waf configure build
13
14 If you have aubio installed in an unusual location, just set your
15 PKG_CONFIG_PATH accordingly. For instance, to build against aubio installed in
16 /var/tmp/aubio:
17
18   $ PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig waf \
19       distclean configure build install --prefix=/var/tmp/aubio 
20
21 Installing
22 ----------
23
24 To install the aubio external for puredata on your system, run the following as
25 root:
26
27   # make install
28
29 Running
30 -------
31
32 To load the external, start pd as follows
33
34   $ pd -lib aubio
35
36 Alternatively, you can create an object [aubio] to initialize the external.
37
38 If you want to use the external without installing it, the above command should
39 work as expected from the pd-aubio source directory. If needed, set your
40 LD_LIBRARY_PATH to include the path to the aubio library.