aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2019-03-31 20:40:42 +0200
committerHanspeter Portner <dev@open-music-kontrollers.ch>2019-03-31 20:40:42 +0200
commit64d438b01fe53a3fb5680d777f506feae92192f3 (patch)
tree07d3dea182131fcbd573f43d07d52bd51557294d /README.md
parent4b0f34760d16f02db841818bfa82339da66c907c (diff)
downloadvm.lv2-64d438b01fe53a3fb5680d777f506feae92192f3.tar.xz
update readme, add screenshot.
Diffstat (limited to 'README.md')
-rw-r--r--README.md72
1 files changed, 59 insertions, 13 deletions
diff --git a/README.md b/README.md
index 4b127a5..cd7ecef 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,70 @@
-# vm.lv2
+## Sherlock
-## A simple Virtual Machine for LV2
+### An investigative LV2 plugin bundle
-
-### Build status
+#### Build status
[![build status](https://gitlab.com/OpenMusicKontrollers/vm.lv2/badges/master/build.svg)](https://gitlab.com/OpenMusicKontrollers/vm.lv2/commits/master)
-### Dependencies
+### Binaries
+
+For GNU/Linux (64-bit, 32-bit, armv7), Windows (64-bit, 32-bit) and MacOS
+(64/32-bit univeral).
+
+To install the plugin bundle on your system, simply copy the __vm.lv2__
+folder out of the platform folder of the downloaded package into your
+[LV2 path](http://lv2plug.in/pages/filesystem-hierarchy-standard.html).
+
+#### Stable release
+
+* [vm.lv2-0.4.0.zip](https://dl.open-music-kontrollers.ch/vm.lv2/stable/vm.lv2-0.4.0.zip) ([sig](https://dl.open-music-kontrollers.ch/vm.lv2/stable/vm.lv2-0.4.0.zip.sig))
+
+#### Unstable (nightly) release
+
+* [vm.lv2-latest-unstable.zip](https://dl.open-music-kontrollers.ch/vm.lv2/unstable/vm.lv2-latest-unstable.zip) ([sig](https://dl.open-music-kontrollers.ch/vm.lv2/unstable/vm.lv2-latest-unstable.zip.sig))
+
+### Sources
+
+#### Stable release
+
+* [vm.lv2-0.4.0.tar.xz](https://git.open-music-kontrollers.ch/lv2/vm.lv2/snapshot/vm.lv2-0.4.0.tar.xz)
+
+#### Git repository
+
+* <https://git.open-music-kontrollers.ch/lv2/vm.lv2>
+
+### Packages
+
+* [ArchLinux](https://www.archlinux.org/packages/community/x86_64/vm.lv2/)
+
+### Bugs and feature requests
+
+* [Gitlab](https://gitlab.com/OpenMusicKontrollers/vm.lv2)
+* [Github](https://github.com/OpenMusicKontrollers/vm.lv2)
+
+### Plugins
+
+![VM ](https://git.open-music-kontrollers.ch/lv2/vm.lv2/plain/screenshots/screenshot_1.png)
+
+#### Control VM
+
+Virtual machine for LV2 Control ports. Features 8 inputs and 8 outputs.
+
+#### CV VM
+
+Virtual machine for LV2 Control Voltage ports. Features 8 inputs and 8 outputs.
+
+#### Audio VM
+
+Virtual machine for LV2 Audio ports. Features 8 inputs and 8 outputs.
+
+#### Atom VM
-* [LV2](http://lv2plug.in) (LV2 Plugin Standard)
+Virtual machine for LV2 Atom event ports. Features 8 inputs and 8 outputs.
-### Build / install
+#### MIDI VM
- git clone https://git.open-music-kontrollers.ch/lv2/vm.lv2
- cd vm.lv2
- meson build
- cd build
- ninja -j4
- sudo ninja install
+Virtual machine for LV2 MIDI event ports. Features 8 inputs and 8 outputs.
### License