update README
[software/lv2-mdametapiano.git] / README.md
1 # LV2 port of the popular mdaPiano and mdaEPiano VSTi
2
3 Port
4 Author: rekado
5
6 Based on the mdaPiano / mdaEPiano sources
7 Source: `mda-vst-src-2010-02-14.zip`
8 Author: Paul Kellett (paul.kellett@mda-vst.com)
9 http://sourceforge.net/projects/mda-vst/
10
11 ----------------------
12
13 ## About
14
15 This is an attempt to merge the mdaEPiano and mdaPiano ports. The two
16 plugins share a lot of code. Putting them together and building both
17 plugins from the same source should make maintenance simpler.
18
19 I'd like to thank Paul Kellett for his decision to put the
20 plugins' source code under a free license (see LICENSE for more info).
21
22
23 ## Compiling
24
25 To compile the plugin, just execute the following statement:
26
27 make && sudo make install
28
29 This will copy the compiled plugin to `/usr/local/lib/lv2`.
30
31 **NOTE**: you will need the lvtoolkit libraries to compile this plugin: http://lvtoolkit.org
32
33
34 ## Connecting
35
36 At the current stage you will need an LV2 host to use the plugin. I'm using
37 `lv2_jack_host` during development:
38
39 lv2_jack_host http://elephly.net/lv2/mdaPiano
40
41 You should now be able to connect your MIDI device to the plugin via JACK. Also
42 don't forget to connect the plugin's stereo output to your system's outputs:
43
44 jack_connect system:playback_1 mdaPiano:left
45 jack_connect system:playback_2 mdaPiano:right
46
47 At least this is what I do on my system. I provide a simple connect script with
48 the code which does these things automatically.
49
50
51 ## License
52
53 The original mda VST plug-ins by Paul Kellett are released under the
54 MIT license or under the GPL "either version 2 of the License, or (at
55 your option) any later version". The LV2 ports of the mdaPiano and
56 mdaEPiano plugins by rekado are released under the same licenses.