update LV2 synth "documentation"
authorrekado <rekado@elephly.net>
Thu, 12 Feb 2015 16:53:31 +0000 (17:53 +0100)
committerrekado <rekado@elephly.net>
Thu, 12 Feb 2015 16:53:31 +0000 (17:53 +0100)
static/lv2/mdaepiano.markdown
static/lv2/mdapiano.markdown

index 9655da0..0ddf614 100644 (file)
@@ -6,10 +6,52 @@ based on was written by Paul Kellett.
 
 The original [announcement post can be found here](/posts/2010-10-14-chinese-tune-mda-epiano.html).
 
-## Documentation
 
-TODO
+## Compiling
+
+To compile the mda Piano plugin, just execute the following statement:
+
+    make && sudo make install
+
+This will copy the compiled plugin to `/usr/local/lib/lv2`.  To change
+the target prefix, pass the `PREFIX` variable to `make`.
+
+To build the mda EPiano plugin, pass `TYPE=mdaEPiano` to `make`:
+
+    make TYPE=mdaEPiano
+    sudo make install TYPE=mdaEPiano
+
+**NOTE**: you will need the [lvtoolkit libraries](http://lvtoolkit.org) to
+compile this plugin.
+
+
+## Connecting
+
+You will need an LV2 host to use the plugin. I'm using `jalv.gtk`:
+
+    jalv.gtk http://elephly.net/lv2/mdaPiano
+
+You should now be able to connect your MIDI device to the plugin via JACK. Also
+don't forget to connect the plugin's stereo output to your system's outputs:
+
+    jack_connect system:playback_1 mdaPiano:left
+    jack_connect system:playback_2 mdaPiano:right
+
+I provide a simple connect script with the code which does these things
+automatically.
+
+
+## License
+
+The original mda VST plug-ins by Paul Kellett are released under the
+MIT license or under the GPL "either version 2 of the License, or (at
+your option) any later version". The LV2 ports of the mdaPiano and
+mdaEPiano plugins by rekado are released under GPLv3, or (at your
+option) any later version.
+
 
 ## Download
 
-[Fetch the source here](https://github.com/rekado/lv2-mdaEPiano).
+[Fetch the source here](https://gitorious.org/lv2-synths/lv2-mdametapiano).
+The latest
+[release tarball can be downloaded here](https://gitorious.org/lv2-synths/lv2-mdametapiano/archive/0.0.2.tar.gz).
index 8abaf54..ed34d44 100644 (file)
@@ -4,10 +4,52 @@ This is an LV2 port of the mdaPiano VSTi (not to be confused with the
 [mdaEPiano](/lv2/mdaepiano.html)). The original VST that this port is based on
 was written by Paul Kellett.
 
-## Documentation
 
-TODO
+## Compiling
+
+To compile the mda Piano plugin, just execute the following statement:
+
+    make && sudo make install
+
+This will copy the compiled plugin to `/usr/local/lib/lv2`.  To change
+the target prefix, pass the `PREFIX` variable to `make`.
+
+To build the mda EPiano plugin, pass `TYPE=mdaEPiano` to `make`:
+
+    make TYPE=mdaEPiano
+    sudo make install TYPE=mdaEPiano
+
+**NOTE**: you will need the [lvtoolkit libraries](http://lvtoolkit.org) to
+compile this plugin.
+
+
+## Connecting
+
+You will need an LV2 host to use the plugin. I'm using `jalv.gtk`:
+
+    jalv.gtk http://elephly.net/lv2/mdaPiano
+
+You should now be able to connect your MIDI device to the plugin via JACK. Also
+don't forget to connect the plugin's stereo output to your system's outputs:
+
+    jack_connect system:playback_1 mdaPiano:left
+    jack_connect system:playback_2 mdaPiano:right
+
+I provide a simple connect script with the code which does these things
+automatically.
+
+
+## License
+
+The original mda VST plug-ins by Paul Kellett are released under the
+MIT license or under the GPL "either version 2 of the License, or (at
+your option) any later version". The LV2 ports of the mdaPiano and
+mdaEPiano plugins by rekado are released under GPLv3, or (at your
+option) any later version.
+
 
 ## Download
 
-[Fetch the source here](https://github.com/rekado/lv2-mdaPiano).
+[Fetch the source here](https://gitorious.org/lv2-synths/lv2-mdametapiano).
+The latest
+[release tarball can be downloaded here](https://gitorious.org/lv2-synths/lv2-mdametapiano/archive/0.0.2.tar.gz).