aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2017-03-18 23:00:56 +0100
committerHanspeter Portner <dev@open-music-kontrollers.ch>2017-03-18 23:00:56 +0100
commite7db12af0954a831527b05476a9961219d9154ff (patch)
tree824ddc930d540153da8a502614e66e9be599ae6f /README.md
downloadvm.lv2-e7db12af0954a831527b05476a9961219d9154ff.tar.xz
intial commit.
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2ad2982
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# vm.lv2
+
+## A simple Virtual Machine for LV2
+
+
+### Build status
+
+[![build status](https://gitlab.com/OpenMusicKontrollers/vm.lv2/badges/master/build.svg)](https://gitlab.com/OpenMusicKontrollers/vm.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/vm.lv2.git
+ cd vm.lv2
+ mkdir build
+ cd build
+ cmake ..
+ make
+ sudo make install
+
+### License
+
+Copyright (c) 2017 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>.