aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsowgro <tpoke.ferrari@gmail.com>2024-09-22 00:44:03 -0400
committersowgro <tpoke.ferrari@gmail.com>2024-09-22 00:44:03 -0400
commitda1b21264caf8fd42a1a809c538e2128435160f9 (patch)
treed21d4d8f245d29a8a55becc00d1f25b893881579
parent6e1cf252b0cf45c2daaa3b69414d25a6f5df3b29 (diff)
downloadNPEhero-da1b21264caf8fd42a1a809c538e2128435160f9.tar.gz
NPEhero-da1b21264caf8fd42a1a809c538e2128435160f9.tar.bz2
NPEhero-da1b21264caf8fd42a1a809c538e2128435160f9.zip
Update README with build prereqs
-rwxr-xr-xREADME.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4f966c7..abbc3c2 100755
--- a/README.md
+++ b/README.md
@@ -31,6 +31,26 @@ Execute the maven goal javafx:run
- linux: `./mvnw javafx:run`
### Create an installer for your OS
+Prerequisites:
+
+Ensure that all the following packages are installed and the correct version
+
+- java version >= 22
+- jmod >= 22
+- jlink version >= 22
+- jpackage version >= 22
+
+note: check the version of these with `<package> --version`
+
+You will also need OS specific jpackage prereqs to create the executable
+
+- RPM, DEB on Linux: On Red Hat Linux, we need the rpm-build package; on Ubuntu Linux, we need the fakeroot package
+- PKG, DMG on macOS: Xcode command line tools are required when the –mac-sign option is used to request that the package be signed, and when the –icon option is used to customize the DMG image
+- EXE, MSI on Windows: On Windows, we need the third party tool WiX 3.0 or later
+
+[source](https://www.baeldung.com/java14-jpackage#packaging-prerequisite)
+
+
Execute the maven package phase
- windows: `mvnw.cmd package`
- linux: `./mvnw package`