From 69ce3be60fecfcfc85eb5e2edb3ffec0612703b3 Mon Sep 17 00:00:00 2001 From: sowgro Date: Sun, 8 Sep 2024 01:27:19 -0400 Subject: update pom for more platforms --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0d8e64c..4f966c7 100755 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Goals: - [X] Accept mp3 song files - [ ] UI improvements - [ ] Code cleanup -- [ ] Installer / Linux package +- [X] Installer / Linux package Todo - needs design: - Improve errorList and error handling @@ -20,8 +20,22 @@ Todo - bugs: - Fix notesEditor note preview being too small with no notes - Properly center background image -# Installation -Coming soon. +# Building +### Run the app +Run the Driver class from your IDE (known to work with Intellij) + +OR + +Execute the maven goal javafx:run +- windows: `mvnw.cmd javafx:run` +- linux: `./mvnw javafx:run` + +### Create an installer for your OS +Execute the maven package phase +- windows: `mvnw.cmd package` +- linux: `./mvnw package` + +The installer executables should output to `target/dist` # Development Links -- cgit v1.2.3