Template
Updated Documentation
This commit is contained in:
@@ -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
|
||||
Reference in New Issue
Block a user