.gitignore: ignore waf
[pd-aubio.git] / README.md
1 pd-aubio
2 ========
3
4 Various externals for PureData using the aubio library
5
6 For more information, see:
7   - aubio homepage: https://aubio.org/pd-aubio
8   - puredata homepage: https://puredata.info
9
10 Building
11 --------
12
13 pd-aubio uses waf. To configure and build it, run:
14
15     $ ./waf configure build
16
17 If you have aubio installed in an unusual location, just set your
18 `PKG_CONFIG_PATH` accordingly. For instance, to build against aubio installed
19 in /var/tmp/aubio:
20
21     $ PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig waf \
22         distclean configure build install --prefix=/var/tmp/aubio
23
24 Installing
25 ----------
26
27 To install the aubio external for puredata on your system, run the following as
28 root:
29
30     # make install
31
32 Running
33 -------
34
35 To load the external, start pd as follows
36
37     $ pd -lib aubio
38
39 Alternatively, you can create an object [aubio] to initialize the external.
40
41 If you want to use the external without installing it, the above command should
42 work as expected from the pd-aubio source directory. If needed, set your
43 `LD_LIBRARY_PATH` to include the path to the aubio library.