README.md aktualisiert

README.md

@@ -102,3 +102,48 @@ Tests and execution:
   - Used for automating the build process and managing dependencies.
 - [ANTLR4 v.13.1](https://www.antlr.org/)
   - Used to parse the input Java code into the Abstract Syntax Tree.
+
+## Used Tools
+
+- [Maven 4.0](https://maven.apache.org/index.html)
+  - Used for automating the build process and managing dependencies.
+- [ANTLR4 v.13.1](https://www.antlr.org/)
+  - Used to parse the input Java code into the Abstract Syntax Tree.
+
+## How to run the compiler
+### Possibilities
+### 1. Start miniCompiler using make:
+Make needs to be installed
+```bash
+cd .\src\test\ ; make clean compile-miniCompiler
+```
+
+### 2. Start miniCompiler using jar:
+If you do not have the .jar, download it [here](https://gitea.hb.dhbw-stuttgart.de/i22005/NichtHaskell2.0/src/branch/Endabgabe/src) or compile it using mvn package or make first
+```
+java.exe -DgenJar=bool -DgenClass=bool -jar path_to_jar\jarName.jar 'path_to_input_file.java' 'path_to_output_directory'
+```
+
+Example (jar needs to be in the target directory)
+```bash
+ java.exe -DgenJar=true -DgenClass=true -jar .\target\JavaCompiler-1.0-jar-with-dependencies.jar 'src/main/resources/input/CompilerInput.java' 'src/main/resources/output'
+```
+
+- set DgenJar true, to generate the jar, false for no jar
+
+```
+ DgenJar=true
+```
+
+- set DgenClass true, to generate class files, false for no class files
+
+```
+ DgenClass=true
+ ```
+
+## How to run tests
+
+```bash
+mvn test
+```
+Or start them manually in your IDE