aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2018-06-01 21:47:19 +0200
committerHanspeter Portner <dev@open-music-kontrollers.ch>2018-06-01 21:47:19 +0200
commitd39e8aa120a9f3560491dc83cd1ef73aae34bf39 (patch)
tree0f8050cd258f7532910733ab3faa5267ed5f3338 /README.md
parentca6e06ef9b3827eb30211239a9774b32d42e90f2 (diff)
downloadsynthpod-d39e8aa120a9f3560491dc83cd1ef73aae34bf39.tar.xz
Add mouse/key actions to README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7f1db35d..67263c66 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,41 @@
Get more detailed information at [http://open-music-kontrollers.ch/lv2/synthpod/#](http://open-music-kontrollers.ch/lv2/synthpod/#).
+### Usage
+
+#### Server - client
+
+Synthpod comes as server - client combo, e.g. the server doing the DSP side of things runs in its own
+process and the client showing the GUI side of things runs in its own process.
+
+By default, synthpod just runs the server. There's a command line argument to automatically run the GUI,
+if you want. Please consult the manual page to find out more.
+
+#### GUI
+
+##### Mouse actions
+
+* Plugin actions:
+ * Mouse-over: show connections
+ * Right-click: toggle selection
+ * Left-click-down: start connecting
+ * Left-click-up: end connecting
+
+* Connection matrix actions:
+ * Mouse-over: show connections
+ * Right-click: toggle selection
+ * Left-click: toggle connection
+ * Mouse-wheel: toggle connection
+
+#### Key actions
+
+* a: (de)select all nodes
+* b: start drawing selection box
+* g: start moving selected nodes
+* v: toggle plugin GUIs of selected nodes
+* x: remove selected nodes
+* i: reinstantiate selected nodes
+
### Mandatory dependencies
* [LV2](http://lv2plug.in) (LV2 plugin specification)