Skip to content

Commit a1e3882

Browse files
committed
General slight adjustments and updates
1 parent ff357de commit a1e3882

File tree

3 files changed

+26
-19
lines changed

3 files changed

+26
-19
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,13 @@ generiert `npx hyperbook build` die Website in `./hyperbook/.hyperbook/out`.
6969

7070
Die [öffentliche Seite](https://docs.software-challenge.de)
7171
wird automatisch bei jedem push in den `main`-Branch von GitHub aktualisiert.
72-
Dies geschieht durch einen GitHub Actions Workflow,
73-
siehe `.github/workflows/auto-publish.yml`.
72+
Dies geschieht durch einen [GitHub Actions Workflow](.github/workflows/auto-publish.yml).
7473
Der Workflow speichert die generierten Seiten im `live` branch des Repositories,
7574
welcher nach Benachrichtigung durch einen Webhook von [caddy](./Caddyfile) gepullt wird.
7675

7776
Bei Änderungen am Caddyfile oder dem Docker image
78-
muss [push-production.sh](./bin/push-production.sh) mit dem GITHUB_SECRET des Webhooks ausgeführt werden
77+
muss [push-production.sh](./bin/push-production.sh)
78+
mit dem GITHUB_SECRET des Webhooks ausgeführt werden
7979
(bei credential-abfrage beliebigen Text eingeben).
8080
Der Docker container lässt sich auch lokal mit [test-production.sh](./bin/test-production.sh) testen,
8181
wobei der Caddy Webserver auf port 80 via [localhost](http://localhost) erreichbar wird.

hyperbook/book/entwicklung/installation-von-java.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,22 @@ Diese Anleitung soll die Beschaffung und Installation von Java erleichtern.
1111

1212
## Grundsätzliches
1313

14-
Java gibt es in zwei verschiedenen Paketen: Das *Java Runtime Environment (JRE)* und das *Java Development Kit (JDK)*.
14+
Java gibt es in zwei verschiedenen Paketen:
15+
Das *Java Runtime Environment (JRE)* und das *Java Development Kit (JDK)*.
1516
Zum Entwickeln eigener Programme wird das JDK benötigt, dass auch das JRE enthält.
1617

1718
## Installation
1819

19-
Die Installation des JDK 15 auf einem Windows-System erfolgt mit folgendem `winget`-Befehl im Windows Terminal:
20+
### Windows
21+
22+
Das JDK 11 kann auf einem Windows-System
23+
mit folgendem `winget`-Befehl im Windows Terminal installiert werden:
2024

2125
```bash
22-
winget install -e --id AdoptOpenJDK.OpenJDK.15
26+
winget install -e --id EclipseAdoptium.Temurin.11.JDK
2327
```
2428

2529
### Installation über Paketquellen (Linux)
2630

27-
Meistens ist das JDK (`openjdk`) in den Paketquellen der Linux-Distributionen enthalten, sodass man es einfach über den Paketmanager installieren kann.
31+
Meistens ist das JDK (`openjdk`) direkt von den Paketquellen der Linux-Distribution installierbar.
2832
Sofern möglich, wird diese Art der Installation empfohlen, da es oft noch Paketabhängigkeiten gibt, die dann automatisch mit installiert werden.

hyperbook/glossary/server.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,20 @@ zum anderen sorgt der Spielleiter dafür,
1313
dass sich die Kontrahenten an die Spielregeln halten.
1414

1515
Der Spielleiter ist direkt im [Wettkampfsystem](wettkampfsystem) integriert,
16-
so dass alle Turnierspiele regelkonform gespielt werden.
17-
Zum Testen des eigenen Computerspielers gibt es eine spezielle Version des Spielleiters,
18-
die im [Downloadbereich der Website](https://software-challenge.de/dokumentation-und-material) heruntergeladen werden kann.
19-
Diese Download-Version enthält eine grafische Oberfläche,
20-
durch die man das Spiel gut verfolgen
21-
und sogar als Mensch mitspielen kann.
16+
sodass alle Turnierspiele regelkonform gespielt werden.
17+
Zum Testen des eigenen Computerspielers gibt es eine Version des Spielleiters mit grafischer Oberfläche,
18+
erhältlich im [Downloadbereich der Website](https://software-challenge.de/dokumentation-und-material).
19+
Dadurch kann man das Spiel gut verfolgen
20+
und sogar als Mensch mitspielen.
2221

2322
## System vorbereiten und Spielleiter starten
2423

25-
Die einzige Vorraussetzung ist,
24+
Die einzige Voraussetzung ist
25+
die [Installation einer Java-Laufzeitumgebung](/entwicklung/installation-von-java).
2626
dass auf dem Rechner mindestens die Laufzeitumgebung für Java 11 installiert ist.
27-
Siehe [Installation von Java](/entwicklung/installation-von-java).
2827

29-
Nach der erfolgreichen Installation kann man den grafischen Server
30-
durch einen Doppelklick auf die Datei "software-challenge-gui" starten.
28+
Nach der erfolgreichen Installation kann man den grafischen Server
29+
durch einen Doppelklick auf die Datei `software-challenge-gui` starten.
3130

3231
## Die Programmoberfläche
3332

@@ -90,10 +89,14 @@ um beispielsweise einen Fehler des eigenen Spielers zu analysieren
9089
oder eine Strategie zu verbessern.
9190

9291
Aktuell werden Replay-Dateien automatisch im Unterordner "./replays" abgespeichert.
92+
93+
<!--
9394
Die im Folgenden genannten Anpassungsmöglichkeiten beim Speichern werden noch implementiert.
9495
95-
~Um das aktuelle Spiel als Spielwiederholung zu speichern, klickt man auf das Icon ganz rechts unten im Spielbereich.
96+
~Um das aktuelle Spiel als Spielwiederholung zu speichern,
97+
klick auf das Icon ganz rechts unten im Spielbereich.
9698
Dann kann man einen Dateinamen und Speicherort festlegen.~
99+
-->
97100

98101
Um eine gespeicherte Spielwiederholung zu laden, verwendet man den
99102
Eintrag "Replay laden" im linken Punkt der Menüleiste Nachdem man eine
@@ -182,7 +185,7 @@ und optional mit `--turn` ein Zug spezifiziert werden.
182185

183186
### Replay speichern
184187

185-
Wenn der Server ohne die graphische Oberfläche gestartet wird,
188+
Wenn der Server ohne grafische Oberfläche gestartet wird,
186189
kann `--saveReplay` mitgegeben werden,
187190
damit am Ende jedes Spiels ein Replay unter "./replays" gespeichert wird.
188191

0 commit comments

Comments
 (0)