Readme.md

+# OMR - Optical Music Recognition
+
+OMR is a command-line program analyzing scans of gregorian music sheets to export the notes as textfile or as a pdf via lilypond
+
+## Installation
+
+To build the program following programs are required
+* `Java 8`
+* `Maven`
+* `Lilypond` (if you want to export the scans as pdf)
+
+Install the program with the following commands
+
+### 1. Get the source
+
+Clone the git repository with
+
+    git clone https://gitlab2.informatik.uni-wuerzburg.de/softwarepraktikum/automatic-omr-using-opencv/ && cd automatic-omr-using-opencv
+### 2. Build jar with Maven
+
+    mvn package
+
+### 3. Move jar to desired path
+
+    mv target/optical-music-recognition-1.0-SNAPSHOT.jar PATH/OMR.jar
+(Remember that you have to be at this location to execute the program in future cases)
+
+## Usage
+
+    java -jar OMR.jar [-h] -i <PATH> [-l <PATH>] -o <PATH> [-p] [-s]
+
+* `-h,--help`              Print help
+* `-i,--input <PATH>`      Path of the inputfile
+* `-l,--lilypond <PATH>`   Create pdf with the recognized notes via lilypond - Lilypond must be installed for this Option
+* `-o,--output <PATH>`     Path of the outputfile
+* `-p,--print`             Print output in Terminal
+* `-s,--export-steps`      Exports all intermediate steps as Images to the path of the outputfile