aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..28cf254
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Midi Matrix
+
+## A LV2 Plugin Bundle
+
+### Webpage
+
+Get more information at: [http://open-music-kontrollers.ch/lv2/midi_matrix](http://open-music-kontrollers.ch/lv2/midi_matrix)
+
+### Build status
+
+[![build status](https://gitlab.com/OpenMusicKontrollers/midi_matrix.lv2/badges/master/build.svg)](https://gitlab.com/OpenMusicKontrollers/midi_matrix.lv2/commits/master)
+
+### Dependencies
+
+* [LV2](http://lv2plug.in) (LV2 Plugin Standard)
+* [pugl](http://drobilla.net/software/pugl) (Portable API for OpenGL GUIs)
+* [nuklear](https://github.com/vurtun/nuklear) (Immediate-mode GUI)
+
+### Build / install
+
+ git clone https://github.com/OpenMusicKontrollers/midi_matrix.lv2.git
+ cd midi_matrix.lv2
+ mkdir build
+ cd build
+ cmake ..
+ make
+ sudo make install
+
+### License
+
+Copyright (c) 2015-2016 Hanspeter Portner (dev@open-music-kontrollers.ch)
+
+This is free software: you can redistribute it and/or modify
+it under the terms of the Artistic License 2.0 as published by
+The Perl Foundation.
+
+This source is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+Artistic License 2.0 for more details.
+
+You should have received a copy of the Artistic License 2.0
+along the source as a COPYING file. If not, obtain it from
+<http://www.perlfoundation.org/artistic_license_2_0>.