diff README.md @ 147:5d4727387c93

Some test scripts and doc files
author Chris Cannam <cannam@all-day-breakfast.com>
date Thu, 09 Feb 2017 11:34:24 +0000
parents
children bc181392fc7f
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Thu Feb 09 11:34:24 2017 +0000
@@ -0,0 +1,26 @@
+
+# Piper Vamp Javascript and JSON Adapter
+
+Compile your C++ Vamp plugin code into a Javascript module that
+exports the Piper JSON protocol, for use with Javascript code that
+uses Piper audio feature extractors.
+
+## What this repository contains
+
+ * Adapter code to make a Vamp plugin library into a module that
+   exports request-handling functions for the Piper protocol's JSON
+   serialisation. This code is in C++ and can be compiled to a native
+   shared library or to Javascript with Emscripten.
+
+ * Examples of usage with Vamp plugin code, found in the
+   examples/vamp-example-plugins and examples/vamp-test-plugin
+   directories.
+
+## Authors and licensing
+
+Written by Chris Cannam and Lucas Thompson at the Centre for Digital
+Music, Queen Mary, University of London.
+
+Copyright (c) 2015-2017 Queen Mary, University of London, provided
+under a BSD-style licence. See the file COPYING for details.
+