From 00ff5f6b71d0872bd175b5dd4cd19276f2891444 Mon Sep 17 00:00:00 2001
From: Konrad Neitzel <konrad@kneitzel.de>
Date: Fri, 24 Mar 2023 14:22:29 +0100
Subject: [PATCH] More Information in README and added javafx maven plugin

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++---
 pom.xml   | 10 ++++++++++
 2 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index ad19131..d7bdc99 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,48 @@
 
 Example Maven Project for a JavaFX Application.
 
+**The application is no longer a modular application so there are no problems with dependencies that are not providing a
+module-info.**
+
 This projects includes multiple plugins:
 - Static code analysis with PMD and Spotbugs
 - Check of dependency updates during build
 - Build of an App-Image using JPackage
+- JavaFX plugin to start application
 
-The application is no longer a modular application so there are no problems with dependencies that are not providing a 
-module-info.
+**Important** All commands following should be issued in the root directoy of the project (the directory where you find the pom.xml)
 
-** Build the Image **
+*Quick Start*
+
+- Simply download a zip file of this project and unzip it somewhere on your computer
+- open the opm.xml and change the settings at the start of the document to fit with your project
+
+
+*How to use this project*
+
+**build the application**
+
+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!)
+
+**Clean up**
+
+To clean up the project, call
+```./mvnw package```
+
+**Start the application from commandline**
+```./mvnw javafx:run```
+
+**Build the Image**
 To build the image, the profile Image must be used:
 ```./mvnw -DImage install```
+
+**Important** You cannoz build an image using the javafx plugin. The javafx plugin would require that you build a modular
+Java application and all dependencies providing a module description.
+
+**Static code analysis**
+The static code analysis is done when you build the application. The results can be found in
+- ./target/pmx.xml
+- ./target/spotbugsXml.xml
diff --git a/pom.xml b/pom.xml
index 5bf0b37..157692e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -45,6 +45,7 @@
         <maven.pmd.version>3.16.0</maven.pmd.version>
         <pmd.version>6.55.0</pmd.version>
         <codehaus.version.plugin>2.11.0</codehaus.version.plugin>
+        <javafx.maven.plugin>0.0.8</javafx.maven.plugin>
         <spotbugs.maven.plugin>4.7.2.0</spotbugs.maven.plugin>
         <spotbugs.version>4.7.3</spotbugs.version>
 
@@ -301,6 +302,15 @@
                 </executions>
             </plugin>
 
+            <!-- JavaFX Plugin to start application -->
+            <plugin>
+                <groupId>org.openjfx</groupId>
+                <artifactId>javafx-maven-plugin</artifactId>
+                <version>${javafx.maven.plugin}</version>
+                <configuration>
+                    <mainClass>${main.class}</mainClass>
+                </configuration>
+            </plugin>
         </plugins>
     </build>