summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrekado <rekado@elephly.net>2013-07-28 20:09:06 +0800
committerrekado <rekado@elephly.net>2013-07-28 20:09:06 +0800
commitbd063f37d12eb333bd757c85a8a5761f1a870ac9 (patch)
tree0cfe599b4f99da2de1bdc6f0d0f78ab326280490
parent73937da9aa14effe86c4aebdcf83dff9af6945d9 (diff)
update README
-rw-r--r--README.md33
1 files changed, 17 insertions, 16 deletions
diff --git a/README.md b/README.md
index 516673e..0fb02cd 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,43 @@
# LV2 port of the popular mdaPiano and mdaEPiano VSTi
-Port
- Author: rekado
-
Based on the mdaPiano / mdaEPiano sources
- Source: `mda-vst-src-2010-02-14.zip`
- Author: Paul Kellett (paul.kellett@mda-vst.com)
- http://sourceforge.net/projects/mda-vst/
+- Source: [`mda-vst-src-2010-02-14.zip`](http://sourceforge.net/projects/mda-vst/)
+- Author: Paul Kellett (paul.kellett@mda-vst.com)
+
----------------------
## About
-This is an attempt to merge the mdaEPiano and mdaPiano ports. The two
-plugins share a lot of code. Putting them together and building both
-plugins from the same source should make maintenance simpler.
+This repository holds the code to build the mdaEPiano and mdaPiano plugins for
+the LV2 plugin framework.
I'd like to thank Paul Kellett for his decision to put the
-plugins' source code under a free license (see LICENSE for more info).
+VST plugins' source code under a free license (see LICENSE for more info).
## Compiling
-To compile the plugin, just execute the following statement:
+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 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 to compile this plugin: http://lvtoolkit.org
+**NOTE**: you will need the [lvtoolkit libraries](http://lvtoolkit.org) to
+compile this plugin.
## Connecting
At the current stage you will need an LV2 host to use the plugin. I'm using
-`lv2_jack_host` during development:
+`jalv.gtk`:
- lv2_jack_host http://elephly.net/lv2/mdaPiano
+ 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:
@@ -44,8 +45,8 @@ 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
-At least this is what I do on my system. I provide a simple connect script with
-the code which does these things automatically.
+I provide a simple connect script with the code which does these things
+automatically.
## License