update readme.

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)