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 To configure and build pd-aubio, run:
  14
  15     $ make
  16
  17 pd-aubio uses waf. To find out more information about build options:
  18
  19     $ ./scripts/get_waf.sh
  20     $ ./waf configure --help
  21
  22 Once configured, the external can be built with:
  23
  24     $ ./waf configure build
  25
  26 If you have aubio installed in an unusual location, you might need to set
  27 `PKG_CONFIG_PATH` accordingly.
  28
  29 For instance, to build against aubio installed in `/var/tmp/aubio`:
  30
  31     $ export PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig
  32     $ waf distclean configure build
  33
  34 Installing
  35 ----------
  36
  37 To install pd-aubio:
  38
  39     # ./waf install
  40
  41 Depending on the installation location, you might need to run this command with
  42 sudo (or as the user root), or to copy the files manually.
  43
  44 To install it in a different location, you could also try:
  45
  46     $ ./waf configure --prefix=/my/favorite/place build
  47     # ./waf install
  48
  49 Running
  50 -------
  51
  52 To load the external, start pd as follows
  53
  54     $ pd -lib aubio
  55
  56 Alternatively, you can create an object [aubio] to initialize the external.
  57
  58 If you want to use the external without installing it, the above command should
  59 work as expected from the pd-aubio source directory. If needed, set your
  60 `LD_LIBRARY_PATH` to include the path to your libaubio installation.