First Version README.md

README.md

@@ -1,8 +1,79 @@
-# CIiP-WiSe-2021-Projektarbeit-Mensch_Aerger_Dich_Nicht
+# Mensch ärgere Dich nicht (Continuous Integration in der Praxis WiSe 2021/2022)
 by Jonas Wagner und Felix Krull
 
-## Beschreibung Projekt
+## Projektbeschreibung
 
-## Aufbau Spiel
+Unser Ziel war ein funktionierendes "Mensch ärgere Dich nicht"-Spiel zu erstellen unter Verwendung der Methoden, die
+wir im Modul Continuous Integration in der Praxis gelernt haben. Aktuell läuft das Spiel bereits auf der Konsole.
+Wir haben die Programmiersprache Java, das Build-Tool Maven und Jenkins verwendet. Des Weiteren wurde das Projekt
+Test-Driven entwickelt, daher haben wir eine sehr große Testabdeckung für unseren Code. 
 
-## Struktur Code
+### Für die Zukunft haben wir noch einige Erweiterungen geplant:
+
+- GUI für das Spielbrett + Steuerung
+- Würfel animieren
+- Computergegner implementieren
+- Online spielen
+
+## Inhaltsverzeichnis
+
+- [Voraussetzungen](#Voraussetzungen)
+- [Installation](#Installation)
+- [Bedienung](#Bedienung)
+- [Aufbau](#Aufbau)
+- [Struktur Code](#Struktur Code)
+- [Tests](#Tests)
+- [Authoren](#Authoren)
+
+## Voraussetzungen
+
+- [Java 1.15](https://www.java.com/de/) (sollte aber auch mit fast allen weiteren Versionen funktionieren)
+
+### Dependencies für Maven
+
+- JUnit Jupiter 5.8.2
+- JUnit Platform 1.8.1
+- AssertJ 3.21.0
+
+## Installation
+
+#### 1. Spiel herunterladen
+
+[Herunterladen](https://gogs.informatik.hs-fulda.de/FelixKrull/CIiP-WiSe-2021-Projektarbeit-Mensch_Aerger_Dich_Nicht)
+
+#### 2. Game.java Datei kompilieren
+
+Kompilieren Sie Game.java mit der Java-Version, die in den [Voraussetzungen](#Voraussetzungen) definiert wurden.
+
+## Aufbau
+
+Wenn Sie das Spiel ausführen, startet das Spiel direkt. Es gelten die typischen "Mensch ärgere Dich nicht" - Regeln:
+
+1. Wenn alle Figuren noch nicht auf dem Spielfeld sind, benötigt man eine 6, um eine Figur auf die Startposition der Farbe zu setzen. Hier darf man bis zu 6x würflen.
+2. Wenn Sie eine 6 würfeln, dürfen Sie noch einmal würfeln.
+3. Wer an der Reihe ist, würfelt und darf seine Figur entsprechend dem Würfelergebnis setzen.
+4. Sollte eine Figur von Spieler 1 auf ein Feld kommen, wo eine Figur von Spieler 2 steht, wird die Figur von Spieler 2 geschmissen und kehrt zurück in die Basis.
+5. In dem Haus/Ziel dürfen keine Figuren übersprungen werden
+6. Im Haus/Ziel muss man die genaue Zahl würfeln, um zu setzen. Man kann sich überwerfen.
+
+Die Reihenfolge der Spieler ist wie folgt: Rot -> Blau -> Gelb -> Grün
+
+Am Anfang wird direkt automatisch gewürfelt. Wenn Sie eine oder mehrere Figuren setzen können haben Sie nach dem
+Würfel die Wahl welche Figur Sie setzen möchten.
+
+Diese Aktionen werden so lange wiederholt bis ein Spieler alle Figuren in seinem Haus/Ziel hat.
+
+### Bedienung
+
+Die Bedienung läuft aktuell nur über die Konsole. Sie geben auf die Konsole ein, welche Figur Sie setzen möchten.
+
+Die möglichen Eingaben sind: 0 (erste Figur), 1 (zweite Figur), 2 (dritte Figur), 3 (vierte Figur)
+
+## Struktur Code
+
+## Tests
+
+## Authoren
+
+- [Felix Krull](https://gogs.informatik.hs-fulda.de/FelixKrull)
+- [Jonas Wagner](https://gogs.informatik.hs-fulda.de/Choan312)