Update Maven wrapper and project dependencies

2024-05-09 21:29:17 +02:00
parent 0c9f43fad1
commit d836e46a71
9 changed files with 616 additions and 6 deletions
@@ -0,0 +1,29 @@
+# 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
+
+### 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```
+
+## 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