master > master: codego -> README.md

codego/README.md

@@ -12,7 +12,9 @@ Da ich kein Informatiker bin, sind auch einige Aspekt bestimmt nicht optimal pro
 
 - bash (auch bash-for-windows).
 - golang (mind. 1.6.x)
+- Java11
 
+Dieses Projekt macht von ANTLR4 Gebrauch, um Schemata in Lexer und Parser zu verwandeln. Siehe <https://blog.gopheracademy.com/advent-2017/parsing-with-antlr4-and-go/> für mehr Informationen dazu.
 ## Voreinstellungen ##
 
 - In einer bash-console zu diesem Ordner navigieren und folgenden Befehl ausführen:
@@ -21,7 +23,11 @@ Da ich kein Informatiker bin, sind auch einige Aspekt bestimmt nicht optimal pro
     ## oder
     chmod +x *.sh
     ```
-- In `run.sh` gibt es eine Zeile, die zur Kompilierung des Go-Projektes notwendigen Module über **go** installieren lässt. (Die Liste der Packages findet man in der Datei `requirements`). Diese Zeile kann man ruhig nach der ersten Ausführung rauskommentieren.
+- In `run.sh` gibt es eine Zeile, die zur Kompilierung des Go-Projektes notwendigen Module über **go** installieren lässt.
+(Die Liste der Packages findet man in der Datei `requirements`).
+Diese Zeile kann man ruhig nach der ersten Ausführung rauskommentieren.
+- Dazu kommt, dass **antlr4.jar** heruntergeladen wird.
+Mithilfe dieses Java-Archivs werden aus `grammars/*.g4` go-Skripte für die Grammatik erzeugt.
 
 ## Daten ##
 
@@ -37,6 +43,21 @@ go build main.go && ./main
 ```
 ausführen.
 
+Das bash Skript macht folgende Schritte
+
+```bash
+# installiert go-module (kann nach 1. Mal rauskommentiert werden):
+check_requirements;
+# lädt ggf. antlr.jar herunter (wenn fehlt), mit dem die Grammatiken erzeugt werden (kann nach 1. Mal rauskommentiert werden):
+precompile_grammars;
+# kompiliert Go-Projekt (nach jeder Code-Änderung erneut nötig), sonst rauskommentieren:
+compile_programme;
+# führt kompiliertes Programm auf Daten in data.env aus:
+run_programme;
+```
+
+
+
 ## Offene Challenges ##
 
 In der Datei `aussagenlogik/rekursion.go` (relativ zu diesem Ordner) findet man mehrere leere Methoden (mit dem Kommentar `// Herausforderung...`). Wer es mag, kann versuchen, an seinem Rechner diese Methoden zu definieren und auszuprobieren.