changeset 170:4fc5d24a3272

Quick note on generator
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 17 Jul 2017 15:24:04 +0100
parents 9c746a913d7f
children 395304838d4d 04bb3a41a3b2
files README.md
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Wed Jun 28 09:26:29 2017 +0100
+++ b/README.md	Mon Jul 17 15:24:04 2017 +0100
@@ -22,6 +22,16 @@
    examples/vamp-example-plugins and examples/vamp-test-plugin
    directories.
 
+ * A utility (piper-vamp-stub-generator) that loads up an existing
+   Vamp plugin and queries it along with its accompanying metadata,
+   writing out a first draft of the converted module's main function
+   code based on what it finds in the plugin.
+
+ * A complete worked example of using that utility and building the
+   resulting module, in a Docker script that can be read as
+   documentation or run within Docker on Linux, found in
+   examples/docker/Dockerfile.
+
 ## Authors and licensing
 
 Written by Chris Cannam and Lucas Thompson at the Centre for Digital