From e15038846d802ad10d8a780951fa9e0f1bf4cf06 Mon Sep 17 00:00:00 2001 From: Aaron Alef Date: Wed, 1 Apr 2020 20:35:31 +0200 Subject: [PATCH 1/7] docs(readme): fix wrong capitalisations and adjust a few sentences --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index fb31d3c5c..571445294 100644 --- a/README.md +++ b/README.md @@ -14,40 +14,40 @@ Das offizielle Repository der [Software-Challenge](https://www.software-challeng ## Collaboration -Wir nutzen den type-scope commit message Syntax nach [Karma Runner](http://karma-runner.github.io/4.0/dev/git-commit-msg.html), wobei die verfügbaren scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem klonen des repositories einmal folgendes im Terminal aus, damit die entsprechenden git hooks aktiv werden: +Die Type-Scopes unserer Commit-Messages folgen der [Karma Runner](http://karma-runner.github.io/4.0/dev/git-commit-msg.html) Konvention, wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repositories einmal Folgendes im Terminal aus, damit die entsprechenden Git Hooks aktiv werden: git config core.hooksPath .dev/githooks -Um bei den Branches die Übersicht zu behalten, sollten diese ebenfalls nach der Konvention benannt werden - z.B. könnte ein Branch mit einem Release-fix für gradle `fix/gradle-release` heißen und ein Branch, der ein neues login-feature zum server hinzufügt, `feat/server-login`. -Branches werden normalerweise beim mergen gesquashed, außer die einzelnen commits des branches haben jeweils eine alleinstehende Aussagekraft. +Um bei den Branches die Übersicht zu behalten, sollten diese ebenfalls nach der Konvention benannt werden - z.B. könnte ein Branch mit einem Release-Fix für Gradle `fix/gradle-release` heißen und ein Branch, der ein neues Login-Feature zum Server hinzufügt, `feat/server-login`. +Branches werden normalerweise beim Mergen zu einem einselnen Commit zusammengefügt (Squash-Merge), es sei denn, die einzelnen Commits des Branches haben jeweils eine alleinstehende Aussagekraft. -Detaillierte Informationen zu unserem Kollaborations-stil findet ihr in der [Kull Convention](https://xerus2000.github.io/kull). +Detaillierte Informationen zu unserem Kollaborations-Stil findet ihr in der [Kull Convention](https://xerus2000.github.io/kull). ## Build -Als Build-Tool wird [Gradle](https://gradle.org/) verwendet. Das gesamte Projekt kann sofort nach dem checkout per `./gradlew build` gebaut werden, es ist keine Installation von Programmen nötig. +Als Build-Tool wird [Gradle](https://gradle.org/) verwendet. Das gesamte Projekt kann sofort nach dem Checkout per `./gradlew build` gebaut werden, es ist keine Installation von Programmen nötig. Die wichtigsten Tasks: | Task | Beschreibung | ------ | ------------ -| `build` | baut alles, deployt und testet -| `test` | führt tests aus -| `deploy` | erstellt hochladbare ZIP-Pakete -| `integrationTest` | testet ein komplettes Spiel sowie den TestClient -| `startServer` oder `:server:run` | führt den Server direkt vom Quellcode aus -| `:server:startProduction` | startet den gepackten Server -| `:player:run` | startet den SimpleClient direkt vom Sourcecode -| `:player:shadowJar` | baut eine jar des SimpleClient -| `:test-client:run` | startet den Testclient +| `build` | Baut alles, deployt und testet +| `test` | Führt Tests aus +| `deploy` | Erstellt hochladbare ZIP-Pakete +| `integrationTest` | Testet ein komplettes Spiel sowie den TestClient +| `startServer` oder `:server:run` | Führt den Server direkt vom Quellcode aus +| `:server:startProduction` | Startet den gepackten Server +| `:player:run` | Startet den SimpleClient direkt vom Sourcecode +| `:player:shadowJar` | Baut eine jar des SimpleClient +| `:test-client:run` | Startet den Testclient ### Unterprojekte Tasks in Unterprojekten können über zwei Wege aufgerufen werden: `./gradlew :server:run` führt die Task "run" des Unterprojektes "server" aus. -Alternativ kann man in das server-Verzeichnis wechseln und dort `./gradlew run` ausführen. +Alternativ kann man in das Server-Verzeichnis wechseln und dort `./gradlew run` ausführen. -Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 Argument2"` zusätzlich Argumente mitgegeben werden. Zum Beispiel kann der TestClient mit folgendem Befehl direkt aus dem sourcecode getestet werden: +Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 Argument2"` zusätzlich Argumente mitgegeben werden. Zum Beispiel kann der TestClient mit folgendem Befehl direkt aus dem Sourcecode getestet werden: ./gradlew :test-client:run -Dargs="--player1 ../../player/build/libs/defaultplayer.jar --player2 ../../player/build/libs/defaultplayer.jar --tests 3" @@ -64,7 +64,7 @@ In Intellij kann man das Projekt bequem von Gradle importieren, wodurch alle Mod - "Use auto-import" ankreuzen - bei "Gradle JVM" JDK 8 auswählen, wenn sie nicht schon ausgewählt ist - "Finish" drücken -- Warten, bis das Gradle build fertig ist +- Warten, bis der Gradle build fertig ist - Einmal im Terminal `git checkout .idea` ausführen, um sich die codeStyles zurückzuholen -Nun können Gradle tasks auch direkt in IDEA vom Gradle Tool Window (befindet sich normalerweise in der rechten Andockleiste) ausgeführt werden. +Nun können Gradle tasks auch direkt in IDEA vom Gradle Tool Window ausgeführt werden; dieses befindet sich normalerweise in der rechten Andockleiste. From 5ef2288761d52323562bccc9ee7b67a397c0c839 Mon Sep 17 00:00:00 2001 From: Aaron Alef Date: Wed, 1 Apr 2020 20:58:53 +0200 Subject: [PATCH 2/7] docs(readme): include a short challenge intro in the abstract --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 571445294..ffe3c3fa5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Software-Challenge [![Build Status](https://travis-ci.com/CAU-Kiel-Tech-Inf/socha.svg?branch=master)](https://travis-ci.com/CAU-Kiel-Tech-Inf/socha) -Das offizielle Repository der [Software-Challenge](https://www.software-challenge.de/), welches aus Server, Client und Spiel-Plugins besteht. +Dies ist das offizielle Repository der [Software-Challenge](https://www.software-challenge.de/), ein jährlicher Programmierwettbewerb für Schüler. +Ziel hierbei ist, für ein jährlich wechselndes Spiel eine künstliche Intelligenz zu entwickeln, die den Gegenspieler besiegt. +Das Repository besteht aus Server, Client und Spiel-Plugins. ## Struktur @@ -67,4 +69,4 @@ In Intellij kann man das Projekt bequem von Gradle importieren, wodurch alle Mod - Warten, bis der Gradle build fertig ist - Einmal im Terminal `git checkout .idea` ausführen, um sich die codeStyles zurückzuholen -Nun können Gradle tasks auch direkt in IDEA vom Gradle Tool Window ausgeführt werden; dieses befindet sich normalerweise in der rechten Andockleiste. +Nun können Gradle tasks auch direkt in IDEA vom Gradle Tool Window ausgeführt werden; dieses befindet sich normalerweise in der rechten Andockleistefix. From d530a805f68e97f3fb541e42a8c515b5e84712eb Mon Sep 17 00:00:00 2001 From: Aaron Alef Date: Thu, 2 Apr 2020 11:49:19 +0200 Subject: [PATCH 3/7] docs(readme): correct more capitalisation & fix wrong pronoun --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ffe3c3fa5..88aecba29 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Die wichtigsten Tasks: ### Unterprojekte Tasks in Unterprojekten können über zwei Wege aufgerufen werden: -`./gradlew :server:run` führt die Task "run" des Unterprojektes "server" aus. +`./gradlew :server:run` führt den Task "run" des Unterprojektes "server" aus. Alternativ kann man in das Server-Verzeichnis wechseln und dort `./gradlew run` ausführen. Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 Argument2"` zusätzlich Argumente mitgegeben werden. Zum Beispiel kann der TestClient mit folgendem Befehl direkt aus dem Sourcecode getestet werden: @@ -69,4 +69,4 @@ In Intellij kann man das Projekt bequem von Gradle importieren, wodurch alle Mod - Warten, bis der Gradle build fertig ist - Einmal im Terminal `git checkout .idea` ausführen, um sich die codeStyles zurückzuholen -Nun können Gradle tasks auch direkt in IDEA vom Gradle Tool Window ausgeführt werden; dieses befindet sich normalerweise in der rechten Andockleistefix. +Nun können Gradle Tasks auch direkt in IDEA vom Gradle Tool Window ausgeführt werden; dieses befindet sich normalerweise in der rechten Andockleistefix. From 388d9526ba4e5195f7156461dad62bf35b2b4054 Mon Sep 17 00:00:00 2001 From: Aaron Alef Date: Fri, 3 Apr 2020 14:38:32 +0200 Subject: [PATCH 4/7] docs(readme): eliminate duplicate word usage Co-Authored-By: Janek --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 88aecba29..ad5b00a0a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Software-Challenge [![Build Status](https://travis-ci.com/CAU-Kiel-Tech-Inf/socha.svg?branch=master)](https://travis-ci.com/CAU-Kiel-Tech-Inf/socha) -Dies ist das offizielle Repository der [Software-Challenge](https://www.software-challenge.de/), ein jährlicher Programmierwettbewerb für Schüler. +Dies ist das offizielle Repository der [Software-Challenge](https://www.software-challenge.de/), ein Programmierwettbewerb für Schüler. Ziel hierbei ist, für ein jährlich wechselndes Spiel eine künstliche Intelligenz zu entwickeln, die den Gegenspieler besiegt. Das Repository besteht aus Server, Client und Spiel-Plugins. From 360490b2fcf72fa02ac8f50c970ac741030c5369 Mon Sep 17 00:00:00 2001 From: Aaron Alef Date: Fri, 3 Apr 2020 15:02:54 +0200 Subject: [PATCH 5/7] docs(readme): make english terms 'neutral' & a few smaller changes --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ad5b00a0a..b1b8e8d95 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,14 @@ Das Repository besteht aus Server, Client und Spiel-Plugins. ## Collaboration -Die Type-Scopes unserer Commit-Messages folgen der [Karma Runner](http://karma-runner.github.io/4.0/dev/git-commit-msg.html) Konvention, wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repositories einmal Folgendes im Terminal aus, damit die entsprechenden Git Hooks aktiv werden: +Unsere Commit-Messages folgen dem Muster `type(scope): summary` (siehe [Karma Runner Konvention](http://karma-runner.github.io/latest/dev/git-commit-msg.html)), wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repositories einmal Folgendes im Terminal aus, damit die entsprechenden Git Hooks aktiv werden: git config core.hooksPath .dev/githooks -Um bei den Branches die Übersicht zu behalten, sollten diese ebenfalls nach der Konvention benannt werden - z.B. könnte ein Branch mit einem Release-Fix für Gradle `fix/gradle-release` heißen und ein Branch, der ein neues Login-Feature zum Server hinzufügt, `feat/server-login`. -Branches werden normalerweise beim Mergen zu einem einselnen Commit zusammengefügt (Squash-Merge), es sei denn, die einzelnen Commits des Branches haben jeweils eine alleinstehende Aussagekraft. +Um bei den Branches die Übersicht zu behalten, sollten diese ebenfalls nach der Konvention benannt werden - z.B. könnte ein Branch mit einem Release-Fix für Gradle `fix/gradle-release` heißen und ein Branch, das ein neues Login-Feature zum Server hinzufügt, `feat/server-login`. +Branches werden normalerweise beim Mergen zu einem einzelnen Commit zusammengefügt (Squash-Merge), es sei denn, die einzelnen Commits des Branches haben jeweils eine alleinstehende Aussagekraft. -Detaillierte Informationen zu unserem Kollaborations-Stil findet ihr in der [Kull Convention](https://xerus2000.github.io/kull). +Detaillierte Informationen zu unserem Kollaborations-Stil findet ihr in der [Kull Konvention](https://xerus2000.github.io/kull). ## Build @@ -46,10 +46,10 @@ Die wichtigsten Tasks: ### Unterprojekte Tasks in Unterprojekten können über zwei Wege aufgerufen werden: -`./gradlew :server:run` führt den Task "run" des Unterprojektes "server" aus. +`./gradlew :server:run` führt das Task "run" des Unterprojektes "server" aus. Alternativ kann man in das Server-Verzeichnis wechseln und dort `./gradlew run` ausführen. -Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 Argument2"` zusätzlich Argumente mitgegeben werden. Zum Beispiel kann der TestClient mit folgendem Befehl direkt aus dem Sourcecode getestet werden: +Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 Argument2"` zusätzlich Argumente mitgegeben werden. Zum Beispiel kann das TestClient mit folgendem Befehl direkt aus dem Sourcecode getestet werden: ./gradlew :test-client:run -Dargs="--player1 ../../player/build/libs/defaultplayer.jar --player2 ../../player/build/libs/defaultplayer.jar --tests 3" @@ -60,13 +60,13 @@ Zuerst sollte sichergestellt werden, dass die neuste Version von Intellij IDEA v In Intellij kann man das Projekt bequem von Gradle importieren, wodurch alle Module und Bibliotheken automatisch geladen werden. Dazu sind folgende Schritte notwendig: - Projekt klonen: `git clone git@github.com:CAU-Kiel-Tech-Inf/socha.git` -- In IDEA auf "File" > "New" > "Project from existing sources" > socha Verzeichnis auswählen +- In IntelliJ auf "File" > "New" > "Project from existing sources" > socha Verzeichnis auswählen - "Import project from external model" > "Gradle" auswählen - Im folgenden Fenster: - "Use auto-import" ankreuzen - bei "Gradle JVM" JDK 8 auswählen, wenn sie nicht schon ausgewählt ist - "Finish" drücken -- Warten, bis der Gradle build fertig ist +- Warten, bis das Gradle-Build fertig ist - Einmal im Terminal `git checkout .idea` ausführen, um sich die codeStyles zurückzuholen -Nun können Gradle Tasks auch direkt in IDEA vom Gradle Tool Window ausgeführt werden; dieses befindet sich normalerweise in der rechten Andockleistefix. +Nun können Gradle-Tasks auch direkt in IntelliJ vom Gradle-Tool-Fenster ausgeführt werden; dieses befindet sich normalerweise in der rechten Andockleiste. From 183d290708f702e44f0feb72d1d56b5d9a111f29 Mon Sep 17 00:00:00 2001 From: Aaron Alef Date: Fri, 3 Apr 2020 20:48:20 +0200 Subject: [PATCH 6/7] docs(readme): correct a few more things --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b1b8e8d95..ddeaaa19a 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Das Repository besteht aus Server, Client und Spiel-Plugins. ## Collaboration -Unsere Commit-Messages folgen dem Muster `type(scope): summary` (siehe [Karma Runner Konvention](http://karma-runner.github.io/latest/dev/git-commit-msg.html)), wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repositories einmal Folgendes im Terminal aus, damit die entsprechenden Git Hooks aktiv werden: +Unsere Commit-Messages folgen dem Muster `type(scope): summary` (siehe [Karma Runner Konvention](http://karma-runner.github.io/latest/dev/git-commit-msg.html)), wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repositories einmal Folgendes im Terminal aus, damit die entsprechenden Git-Hooks aktiv werden: git config core.hooksPath .dev/githooks @@ -53,11 +53,11 @@ Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 ./gradlew :test-client:run -Dargs="--player1 ../../player/build/libs/defaultplayer.jar --player2 ../../player/build/libs/defaultplayer.jar --tests 3" -### Arbeiten mit Intellij IDEA +### Arbeiten mit IntelliJ IDEA -Zuerst sollte sichergestellt werden, dass die neuste Version von Intellij IDEA verwendet wird, da es ansonsten Probleme mit Kotlin geben kann. +Zuerst sollte sichergestellt werden, dass die neuste Version von IntelliJ IDEA verwendet wird, da es ansonsten Probleme mit Kotlin geben kann. -In Intellij kann man das Projekt bequem von Gradle importieren, wodurch alle Module und Bibliotheken automatisch geladen werden. Dazu sind folgende Schritte notwendig: +In IntelliJ kann man das Projekt bequem von Gradle importieren, wodurch alle Module und Bibliotheken automatisch geladen werden. Dazu sind folgende Schritte notwendig: - Projekt klonen: `git clone git@github.com:CAU-Kiel-Tech-Inf/socha.git` - In IntelliJ auf "File" > "New" > "Project from existing sources" > socha Verzeichnis auswählen From 093cd7330f829db8401851fd0411e01bc35abff3 Mon Sep 17 00:00:00 2001 From: Aaron Alef Date: Thu, 16 Apr 2020 13:46:29 +0200 Subject: [PATCH 7/7] docs(readme): change prenouns and capitalisation --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ddeaaa19a..5dee8a553 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,18 @@ Das Repository besteht aus Server, Client und Spiel-Plugins. | Ordner | Beschreibung | | ------ | ------------ | | helpers | Zusätzliche Tools (aktuell nur der TestClient) | -| player | Simpleclient dieses Jahres | +| player | SimpleClient dieses Jahres | | plugin | Plugin dieses Jahres | | server | Spielserver | | socha-sdk | Projektübergreifend verwendete Klassen | ## Collaboration -Unsere Commit-Messages folgen dem Muster `type(scope): summary` (siehe [Karma Runner Konvention](http://karma-runner.github.io/latest/dev/git-commit-msg.html)), wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repositories einmal Folgendes im Terminal aus, damit die entsprechenden Git-Hooks aktiv werden: +Unsere Commit-Messages folgen dem Muster `type(scope): summary` (siehe [Karma Runner Konvention](http://karma-runner.github.io/latest/dev/git-commit-msg.html)), wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repository's einmal Folgendes im Terminal aus, damit die entsprechenden Git-Hooks aktiv werden: git config core.hooksPath .dev/githooks -Um bei den Branches die Übersicht zu behalten, sollten diese ebenfalls nach der Konvention benannt werden - z.B. könnte ein Branch mit einem Release-Fix für Gradle `fix/gradle-release` heißen und ein Branch, das ein neues Login-Feature zum Server hinzufügt, `feat/server-login`. +Um bei den Branches die Übersicht zu behalten, sollten diese ebenfalls nach der Konvention benannt werden - z.B. könnte ein Branch mit einem Release-Fix für Gradle `fix/gradle-release` heißen und ein Branch, der ein neues Login-Feature zum Server hinzufügt, `feat/server-login`. Branches werden normalerweise beim Mergen zu einem einzelnen Commit zusammengefügt (Squash-Merge), es sei denn, die einzelnen Commits des Branches haben jeweils eine alleinstehende Aussagekraft. Detaillierte Informationen zu unserem Kollaborations-Stil findet ihr in der [Kull Konvention](https://xerus2000.github.io/kull). @@ -41,15 +41,15 @@ Die wichtigsten Tasks: | `:server:startProduction` | Startet den gepackten Server | `:player:run` | Startet den SimpleClient direkt vom Sourcecode | `:player:shadowJar` | Baut eine jar des SimpleClient -| `:test-client:run` | Startet den Testclient +| `:test-client:run` | Startet den TestClient ### Unterprojekte Tasks in Unterprojekten können über zwei Wege aufgerufen werden: -`./gradlew :server:run` führt das Task "run" des Unterprojektes "server" aus. +`./gradlew :server:run` führt den Task "run" des Unterprojektes "server" aus. Alternativ kann man in das Server-Verzeichnis wechseln und dort `./gradlew run` ausführen. -Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 Argument2"` zusätzlich Argumente mitgegeben werden. Zum Beispiel kann das TestClient mit folgendem Befehl direkt aus dem Sourcecode getestet werden: +Bei der Ausführung eines Unterprojekts via `run` können per `-Dargs="Argument1 Argument2"` zusätzlich Argumente mitgegeben werden. Zum Beispiel kann der TestClient mit folgendem Befehl direkt aus dem Sourcecode getestet werden: ./gradlew :test-client:run -Dargs="--player1 ../../player/build/libs/defaultplayer.jar --player2 ../../player/build/libs/defaultplayer.jar --tests 3"