README überarbeiten

This commit is contained in:
Jocelyn 2025-04-01 10:25:57 +02:00
parent 4b19b5b0f3
commit 9b8ecc8555

View file

@ -3,37 +3,36 @@ Beleg SoSe 2025
EINLEITUNG
In diesem Ordner befinden sich fast alle notwendigen Dateien um die vorliegende
Belegarbeit zu kompilieren. Für zusätzliche Abhängigkeiten siehe KOMPILIEREN.
Im Ordner src befindet sich der Java-Quellcode der Anwendung und im Ordner doc
wird die Javadoc-Dokumentation ausgegeben.
Hier eine Kurzanleitung zum Kompilieren und ausführen. Eine ausführlichere
Beschreibung befindet sich im schriftlichen Teil der Belegarbeit.
AUSFÜHREN
Da die Anwendung keine grafische Oberfläche im klassischen Sinne nutzt
empfiehlt sich ein Starten über die Komandozeile mit
java -jar build/jar/beleg.jar
Beendet werden kann die Anwendung mit Ctrl+C.
Zum Vergleich mit einer "getesteten Instanz" gibt es mindestens bis zum Anfang
des WiSe 25/26 noch eine von mir gehostete Version unter
http://beleg.infra.jossco.de.
KOMPILIEREN
Die folgenden Schritte beschreiben das Kompilieren der Anwendung sowie der
Dokumentation und zusätzlich der schriftlichen Belegarbeit.
Abhängigkeiten für die Anwendung:
* Apache ANT
* Das Java JDK, mindestens in Version 8
* Das aktuelle Java JDK
Für die Dokumentation wird zusätzlich Javadoc benötigt.
Gegeben dass die Abhängigkeiten installiert sind, kann einfach durch
ant run
die Anwendung ausgeführt werden. Kompiliert wird die Anwendung dabei
automatisch. Das ist auf den Linux Mint 22 Installationen auf den Pool PCs der
Hochschule getestet.
Zum Vergleich mit einer "getesteten Instanz" im Zweifelsfall gibt es noch eine
von mir gehostete Version unter
http://beleg.infra.jossco.de
DOKUMENTATION
Die Dokumentation befindet sich im Ordner doc. Neu erstellt werden kann sie mit
ant doc
Dafür wird zusätzlich zu den Abhängigkeiten oben noch Javadoc benötigt.