aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2019-04-01 19:24:15 +0200
committerHanspeter Portner <dev@open-music-kontrollers.ch>2019-04-01 19:25:01 +0200
commit642a471ac1d7225ebe406e5bb1373467d712a95a (patch)
tree28c8d0ab458518eb504d06011c6de4b68083f435 /README.md
parenteb84f5a922c621f452375e581b1378006327ad78 (diff)
downloadmoony.lv2-642a471ac1d7225ebe406e5bb1373467d712a95a.tar.xz
update readme.
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5d110b6..bbc4feb 100644
--- a/README.md
+++ b/README.md
@@ -164,6 +164,44 @@ is this here:
4x control + 1x atom input to 4x control + 1x atom output.
+### Dependencies
+
+* [LV2](http://lv2plug.in) (LV2 Plugin Standard)
+
+### Build / install
+
+ git clone https://git.open-music-kontrollers.ch/lv2/moony.lv2
+ cd moony.lv2
+ meson -Dbuild-zimple-ui=true build
+ cd build
+ ninja -j4
+ sudo ninja install
+ ninja test
+
+### GUI
+
+This plugin features an external LV2 plugin GUI, which does nothing else than
+just opening the plugin's Lua source in your favorite editor and monitor its
+modification state.
+
+*The external GUI is optionally built only.*
+
+Currently, the editor has to be defined via an environment variable. You can
+use either the environment varialbe *EDITOR* or *MOONY_EDITOR*, whereby the
+latter will take precedence over the former.
+
+ export EDITOR='urxvt -e nvim'
+
+If no environment variable is defined, the default fallback invocation commands
+are defined as follows:
+
+* 'xterm -e vi' (Unix)
+* 'open -nW' (MacOS)
+* 'cmd /c start /wait' (Windows)
+
+Whenever you save the Lua source, the plugin will try to just-in-time compile and
+inject it. Potential warnings and errors are reported in the plugin host's log.
+
### License
Copyright (c) 2015-2017 Hanspeter Portner (dev@open-music-kontrollers.ch)