From cd29a3dec8fb292c79f0264a8b79d3221c66a12e Mon Sep 17 00:00:00 2001 From: David Robillard Date: Fri, 27 May 2022 19:10:55 -0400 Subject: Update documentation --- NEWS | 3 ++- README.md | 24 ++++++++++++------------ 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/NEWS b/NEWS index 532a191..e31c8ff 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,6 @@ jalv (1.6.7) unstable; + * Add Gtk plugin selector UI and desktop file * Add missing option in console help output * Add version option to console executable * Build Qt and Gtkmm versions as C++14 @@ -9,7 +10,7 @@ jalv (1.6.7) unstable; * Flush stdout after printing control values in console interface * Remove Qt4 support - -- David Robillard Fri, 27 May 2022 18:42:52 +0000 + -- David Robillard Fri, 27 May 2022 22:56:00 +0000 jalv (1.6.6) stable; diff --git a/README.md b/README.md index 430175a..a93993d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ Jalv ==== -Jalv is a simple but fully featured LV2 host for Jack which exposes plugin -ports to Jack, essentially making any LV2 plugin function as a Jack -application. -For more information, see . +Jalv (JAck LV2) is a simple host for LV2 plugins. It runs a plugin, and +exposes the plugin ports to the system, essentially making the plugin an +application. For more information, see . -Jalv is a small program which is useful, but also intended to be an appropriate -test host for plugin development. It runs plugins from the command line with -no user interaction, is light enough to run in valgrind, and is capable of -dumping all communication between the plugin and its UI in a human readable -format. +Jalv can be built to run on JACK, where plugin ports are exposed directly as +JACK ports, or via PortAudio, where the plugin is connected to the system +inputs and outputs. -To make it simple to test plugins in hosts that use different toolkits, there -are several Jalv executables: jalv, jalv.gtk, jalv.gtk3, jalv.gtkmm, jalv.qt4, -and jalv.qt5. +Jalv is particularly useful as a simple test host for plugin development and +testing. It runs plugins from the command line with no user interaction, is +light enough to run with tools like sanitizers or valgrind, and is capable of +dumping all communication between the plugin and its UI in a human readable +format. Plugin UIs can be tested in different host toolkits by using different +executables: jalv, jalv.gtk, jalv.gtk3, jalv.gtkmm, and jalv.qt5. -- David Robillard -- cgit v1.2.1