aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2020-04-13 14:42:46 +0200
committerHanspeter Portner <dev@open-music-kontrollers.ch>2020-04-13 14:42:46 +0200
commit29b915a9c661d8b527c6f19fbfbf4124ef9fde6d (patch)
treedc8c33647e49c6e205d25d76a0a1feefb02aa640
parentb3b363903f1cef2e41e47193ba397a478161a813 (diff)
downloadmoony.lv2-29b915a9c661d8b527c6f19fbfbf4124ef9fde6d.tar.xz
readme: update with next-ui.
-rw-r--r--README.md44
-rw-r--r--VERSION2
2 files changed, 27 insertions, 19 deletions
diff --git a/README.md b/README.md
index 9fa4752..cb2024d 100644
--- a/README.md
+++ b/README.md
@@ -171,11 +171,17 @@ is this here:
#### mandatory
* [LV2](http://lv2plug.in) (LV2 Plugin Standard)
+* [OpenGl](https://www.opengl.org) (OpenGl)
+* [GLEW](http://glew.sourceforge.net) (GLEW)
#### optional (for inline display)
* [cairo](https://www.cairographics.org) (2D graphics library)
+#### optional (for next ui)
+
+* [vterm](http://www.leonerd.org.uk/code/libvterm) (Virtual terminal emulator)
+
### Build / install
git clone https://git.open-music-kontrollers.ch/lv2/moony.lv2
@@ -189,33 +195,35 @@ is this here:
#### Compile options
* build-opengl-ui (build OpenGl UI, default=on)
-* build-simple-ui (build external UI, default=off)
+* build-next-ui (build next UI, default=off)
+ * use-vterm (needed for next ui, default=disabled)
* build-inline-disp (build inline display, default=off)
-### GUI
+### Next (alternative) UI
+
+This plugin features a native LV2 plugin UI which embeds a terminal emulator
+which can run your favorite terminal editor to edit the plugin's FAUST source.
+
+Currently, the editor has to be defined via the environment variable *EDITOR*:
-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.
+ export EDITOR='vim'
+ export EDITOR='emacs'
-*The external GUI is optionally built only.*
+If no environment variable is defined, the default fallback editor is 'vi', as
+it must be part of every POSIX system.
-Currently, the editor has to be defined via an environment variable
-*MOONY_EDITOR*.
+Whenever you save the FAUST 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
+and the UI itself.
- export MOONY_EDITOR='gedit'
- export MOONY_EDITOR='xterm -e emacs'
- export MOONY_EDITOR='urxvt -e nvim'
+On hi-DPI displays, the UI scales automatically if you have set the correct DPI
+in your ~/.Xresources.
-If no environment variable is defined, the default fallback invocation commands
-are defined as follows:
+ Xft.dpi: 200
-* 'xterm -e vi' (Unix)
-* 'open -nW' (MacOS)
-* 'cmd /c start /wait' (Windows)
+If not, you can manually set your DPI via environmental variable *D2TK_SCALE*:
-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.
+ export D2TK_SCALE=200
### License
diff --git a/VERSION b/VERSION
index f799442..d46489f 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.31.53
+0.31.55