diff --git a/README.md b/README.md index 3c1a70f..3e4986a 100644 --- a/README.md +++ b/README.md @@ -2,35 +2,33 @@ "named this way because i didn't realise there was another libremines!" -![Libremines screenshot](https://github.com/shrapnelnet/libremines/assets/133451255/f19e0006-a587-4f39-8626-67606db7cd58) - +![Libremines screenshot](https://github.com/user-attachments/assets/e0a4e551-afdf-4fc5-91c5-7ff45d36cb64) ## Building ### Requirements: -- Java 21 or newer (openjdk-21-jdk) -- Maven 3.8.8 (note: some versions cause gluon to freak out) +- Java 21 +- Maven 3.8.8 or lower - GraalVM 21 ### Instructions: -Create the maven wrapper. gluonfx does not like versions of maven that are not 3.8.8: +Create the maven wrapper at version 3.8.8. GluonFX does not work with newer versions as of 2024-07-27. ```shell mvn wrapper:wrapper -Dmaven=3.8.8 ``` -This is helpful for version management, in case you have an incompatible version of maven installed. -Install dependencies: +Install dependencies, build and run: ```shell -./mvnw install -``` - -Build and run: - -```shell -GRAALVM_HOME=/path/to/graalvm ./mvnw gluonfx:build +./mvnw dependency:resolve gluonfx:build ``` A native binary should be placed at `target/gluonfx//libremines` + +Alternatively, to run using the JVM, use: + +```shell +./mvnw javafx:run +```