Document config

example.cfg

@@ -1,3 +1,31 @@
+# Example configuration for jm2cv
+#
+# Type:
+#  cvout - convert MIDI to CV
+#  cvin  - convert CV to MIDI
+# Name:
+#  arbitrary name for port (no spaces)
+# Channel:
+#  for cvout, chooses MIDI channel to listen on (0-15), or -1 for any
+#  for cvin, chooses MIDI channel to send on (0-15)
+# CC MSB/LSB:
+#  pb    - use pitchbend data, MSB/LSB must be -1
+#  cc    - use control change data, MSB (0-127) for coarse data,
+#          LSB (0-127) or -1 for no LSB
+#  nrpn  - 14 bit data NRPN controller, MSB and LSB required
+#  nrpn7 - 7 bit data NRPN controller, MSB and LSB required
+#  rpn   - as above but for RPN
+#  rpn7  - as above but for RPN
+# MIDI range
+#  lower and upper bounds for sending or receiving MIDI data, value
+#  is clamped to the range
+# CV range
+#  lower and upper bounds for sending or receiving CV data, value
+#  is clamped to the range
+# Latency
+#  for cvout, unused but must be present
+#  for cvin, minimum interval between MIDI messages, to avoid flood
+#
 #type    name   chan, cc MSB/LSB, midi range, cv range,   latency
 cvout    pan    -1    cc 10 -1       0 127       -1.0 1.0    10
 cvout    reverb -1    cc 91 -1       0 127       -1.0 1.0    10