Merge branch 'main' of https://github.com/Markram71/Bitwig-Performanc…

…e-Twister

README.md

@@ -1,2 +1,26 @@
-# Bitwig-Performance-Twister
- Bitwig Extension to use the midi controller "Midi Fighter Twister" with the DAW Bitwig
+
+# Bitwig Performance Twister (Bitwig Extesnsion) 
+ Bitwig Extension to use the midi controller "Midi Fighter Twister" with the DAW Bitwig. 
+
+Directly download the latest release: 
+[![Download](https://img.shields.io/github/downloads/dozius/TwisterSister/total.svg)](https://github.com/markram71/Bitwig-Performance-Twister/releases/latest)
+
+Please see the user documentation with installation instructions here [here](docs/README.md).
+
+
+## Compiling
+
+### Requirements
+
+* JDK 17
+* Bitwig Studio Version 5.1
+* Bitwig Controller API 18
+* Maven 3.9.5 
+
+
+### Build and install
+
+1. Follow the installation instructions for each of the above requirements.
+2. You might want to install an IDE like Eclipse or Visual Studio Code
+3. Run `mvn install`.
+