summaryrefslogtreecommitdiff
path: root/example-scripts/voctomidi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'example-scripts/voctomidi/README.md')
-rw-r--r--example-scripts/voctomidi/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/example-scripts/voctomidi/README.md b/example-scripts/voctomidi/README.md
new file mode 100644
index 0000000..b171f8a
--- /dev/null
+++ b/example-scripts/voctomidi/README.md
@@ -0,0 +1,10 @@
+# Voctomidi - Control Voctocore from a MIDI controller
+
+## Configuration
+Set the `device` option in the `midi` section to the device
+you want to connect to. This can be either a device name, or port.
+If this is unset or the device can't be found a list of connected devices will
+be provided for you to choose from.
+
+In the `eventmap` section MIDI NOTE ON events are mapped to Voctocore layouts.
+The syntax is `<note>=<srcA> <srcB> <mode>`.