Merge pull request #12 from kneitzel/UpdateDocumentation

Update documentation

README.md

@@ -12,43 +12,11 @@ This projects includes multiple plugins:
 - JavaFX plugin to start application
 
 **Requirements**
-To use this Template, all you need is a local Java Installation. My current advice is to use a long term supported (LTS) version of either Java 17 or Java 21.
+To use this Template, all you need is a local Java Installation. 
+My current advice is to use a long term supported (LTS) version of either Java 17 or Java 21.
 
 **Important** All commands following should be issued in the root directoy of the project (the directory where you find the pom.xml)
 
-*Quick Start*
+**[Documentation in English](documentation/en/_Index.md)**
 
-- Simply download a zip file of this project and unzip it somewhere on your computer
+**[Dokumentation in Deutsch](documentation/de/_Index.md)**
-- open the pom.xml and change the settings at the start of the document to fit with your project
-
-
-*How to use this project*
-
-**Start the application from commandline**
-```./mvnw javafx:run```
-
-**Clean up**
-
-To clean up the project, call
-```./mvnw clean```
-
-**build the application (Without building the application image) **
-
-To build the application, maven / the maven wrapper can be used. Simply do a
-```./mvnw package```
-to build the application.
-(simply call mvnw instead of ./mvnw on windows!)
-
-**Build the Image**
-
-To build the image, the profile Image must be used:
-```./mvnw -DImage install```
-
-**Important** You cannot build an image using the javafx plugin. The javafx plugin requires that you build a modular
-Java application and all dependencies providing a module description.
-
-**Static code analysis results**
-
-The static code analysis is done during the build of the application. The results can be found in
-- ./target/pmd.xml
-- ./target/spotbugsXml.xml

documentation/de/QuickStart.md

@@ -0,0 +1,42 @@
+# Schnellstart
+
+- Lade einfach das Projekt als ZIP Datei von GitHub und entpacke es an einer 
+Stelle Deiner Wahl auf dem Computer.
+- Öffne die pom.xl und ändere die Einstellungen am Anfang des Dokumentes.
+
+**Hinweis**: Im folgenden werden die Befehle für Unix artige Systeme / macos
+angegeben. Unter Windows kannst Du am Anfang des Befehles das ./mvnw durch mvnw
+ersetzen.
+
+## Wie kannst Du das Projekt nutzen
+
+### Start der Anwendung von der Kommandozeile
+```./mvnw javafx:run```
+
+### Projekt bereinigen
+
+Um das Projekt zu bereinigen, kannst Du
+```./mvnw clean```
+aufrufen.
+
+### Übersetzen der Anwendung (Ohne ein Image zur Weitergabe zu bauen)
+
+Um die Anwendung zu übersetzen kannst Du aufrufen:
+```./mvnw package```
+
+### Bau des Images zur weitergabe
+
+Um das Image zu bauen, rufst du einfach Maven mit dem Profil Image und dem
+Ziel install auf:
+```./mvnw -DImage install```
+
+**Wichtig** Du kannst nicht das JavaFX Plugin mit dem Ziel javafx:jlink verwenden,
+da dieses Plugin zwingend eine Modulbeschreibung für das Projekt und alle
+Abhängigkeiten erfordert.
+
+## Ergebnisse der statischen Codeanalyse
+
+Die Codeanalyse läuft automatisch beim Bau des Projektes und die Ergebnisse
+finden sich in:
+- ./target/pmd.xml
+- ./target/spotbugsXml.xml

documentation/de/_Index.md

@@ -0,0 +1,15 @@
+# Übersicht über die Dokumentation
+
+- [Schnellstart](QuickStart.md)
+
+## Maven Projekt
+- [Übersicht über das Maven Projekt](MavenProject.md)
+- [Erzeugung eines Images](ImageCreation.md)
+- Überprüfung auf Aktualisierungen
+
+# Statische Codeanalyse
+- PMD
+- SpotBugs
+
+# Sonstiges
+- Lombok

documentation/en/QuickStart.md

@@ -0,0 +1,35 @@
+# Quick Start
+
+- Simply download a zip file of this project and unzip it somewhere on your computer
+- open the pom.xml and change the settings at the start of the document to fit with your project
+
+## How to use this project
+
+### Start the application from commandline
+```./mvnw javafx:run```
+
+### Clean up
+
+To clean up the project, call
+```./mvnw clean```
+
+### build the application (Without building the application image)
+
+To build the application, maven / the maven wrapper can be used. Simply do a
+```./mvnw package```
+to build the application.
+(simply call mvnw instead of ./mvnw on windows!)
+
+### Build the Image
+
+To build the image, the profile Image must be used:
+```./mvnw -DImage install```
+
+**Important** You cannot build an image using the javafx plugin. The javafx plugin requires that you build a modular
+Java application and all dependencies providing a module description.
+
+## Static code analysis results
+
+The static code analysis is done during the build of the application. The results can be found in
+- ./target/pmd.xml
+- ./target/spotbugsXml.xml

documentation/en/_Index.md

@@ -0,0 +1,15 @@
+# Documentation Overview
+
+- [Quick Start](QuickStart.md)
+
+## Maven Project
+- [Maven Project Overview](MavenProject.md)
+- [Image Creation](ImageCreation.md)
+- Checking of Updates
+
+## Static Code Analysis
+- PMD
+- FindBugs
+
+## Other Topics
+- Lombok