# HG changeset patch
# User Chris Cannam <cannam@all-day-breakfast.com>
# Date 1497431225 -3600
# Node ID 6f01107166d515aabbb97cb3d070737b27f988ae
# Parent  38675dcea44fdc298d311c9e5a12f9f3fbef4bc3
Comment

diff -r 38675dcea44f -r 6f01107166d5 Makefile.inc
--- a/Makefile.inc	Wed Jun 14 10:06:30 2017 +0100
+++ b/Makefile.inc	Wed Jun 14 10:07:05 2017 +0100
@@ -1,3 +1,34 @@
+
+# This GNU Makefile fragment is intended to be included from the
+# Makefile for a Piper adapter, for use when recompiling an existing
+# Vamp plugin (in C++) into a Javascript module.
+#
+# This fragment defines all of the actual build targets for the
+# module. Your including Makefile should define some or all of the
+# following variables before including it:
+#
+# MODULE_SOURCE - The name of the .cpp file for the module main entry
+# point, e.g. vamp-example-plugins.cpp. You must write this file; it
+# is not the same as the plugin library entry point used for the
+# original Vamp plugin build. You can use the generator program (in
+# piper-vamp-js/generator) to generate a preliminary version based on
+# metadata reported by your actual plugin library, but it will usually
+# still need some editing.
+#
+# MODULE_NAME - The name of the target feature extraction module.
+# Typically a camel-cased representation of the Vamp plugin library
+# name, like VampExamplePlugins.
+#
+# PLUGIN_SOURCES - All C++ source files for the plugin library.
+#
+# PLUGIN_C_SOURCES - Any C source files for the plugin library.
+#
+# DEFINES - Any additional -D flags for the C/C++ compiler.
+#
+# INCLUDES - Any additional -I flags for the C/C++ compiler.
+#
+# EMFLAGS - Any additional Emscripten-specific flags to pass to the
+# compiler.
 
 default:        help