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