From c715466ee01cd9e5681326c89cfa15bea2ecf9ee Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Fri, 3 Feb 2017 21:05:23 +0100 Subject: [PATCH] README.md: improve basic description --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8171e9c..f8f5a9e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # node-aubio -Node.js bindings for [aubio](https://aubio.org), a library for audio labeling: pitch, onset, tempo tracking, and more + +Node.js bindings for [aubio][aubio], a library for audio and music analysis, +synthesis, and effects. aubio features include pitch tracking, onset detectin, +beat tracking (tempo), phase vocoder, biquad and IIR filters. + +In order to use this module, you will need to have [aubio][aubio] installed on +your system. See [aubio's download page][aubio-download] to find out how to get +aubio for your system. + +node-aubio uses [ffi][ffi] to load aubio's dynamic library and use directly the +aubio functions as well as [ref][ref] to access C pointers efficiently. To find +out more about [ffi][ffi] and [ref][ref], read the [Node FFI +Tutorial](https://github.com/node-ffi/node-ffi/wiki/Node-FFI-Tutorial). + +[aubio]: https://aubio.org +[aubio-download]: https://aubio.org/download +[ffi]: https://github.com/node-ffi/node-ffi/wiki/Node-FFI-Tutorial +[ref]: https://github.com/TooTallNate/ref -- 2.11.0