From ec5fc10955c2d8e51b93b894d1038ee16f7113c8 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Tue, 14 Mar 2017 03:41:47 +0100 Subject: [PATCH] README.md: improve markdown formatting, update homepage, use https --- README => README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) rename README => README.md (52%) diff --git a/README b/README.md similarity index 52% rename from README rename to README.md index a1e3873..c3b0308 100644 --- a/README +++ b/README.md @@ -1,22 +1,25 @@ -pd-aubio contains various externals for PureData using the aubio library. +pd-aubio +======== + +Various externals for PureData using the aubio library For more information, see: - - aubio homepage: http://aubio.org - - puredata homepage: http://puredata.info + - aubio homepage: https://aubio.org/pd-aubio + - puredata homepage: https://puredata.info Building -------- pd-aubio uses waf. To configure and build it, run: - $ ./waf configure build + $ ./waf configure build 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` 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 + $ PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig waf \ + distclean configure build install --prefix=/var/tmp/aubio Installing ---------- @@ -24,17 +27,17 @@ Installing To install the aubio external for puredata on your system, run the following as root: - # make install + # make install Running ------- To load the external, start pd as follows - $ pd -lib aubio + $ 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. +`LD_LIBRARY_PATH` to include the path to the aubio library. -- 2.11.0