diff options
| author | sowgro <tpoke.ferrari@gmail.com> | 2024-09-08 01:27:19 -0400 |
|---|---|---|
| committer | sowgro <tpoke.ferrari@gmail.com> | 2024-09-08 01:27:19 -0400 |
| commit | 69ce3be60fecfcfc85eb5e2edb3ffec0612703b3 (patch) | |
| tree | 3049e9b720b74e27889a1b74e2a10675448dfb91 /README.md | |
| parent | 2c0a884082bc96db83c34f2cc83e640b198a3ec0 (diff) | |
| download | NPEhero-69ce3be60fecfcfc85eb5e2edb3ffec0612703b3.tar.gz NPEhero-69ce3be60fecfcfc85eb5e2edb3ffec0612703b3.tar.bz2 NPEhero-69ce3be60fecfcfc85eb5e2edb3ffec0612703b3.zip | |
update pom for more platforms
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 20 |
1 files changed, 17 insertions, 3 deletions
@@ -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 |