diff --git a/README.md b/README.md index 31fefea..92e9e34 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ ## ITSF Ranking App +To run the app you need to have a Java JRE installed (version 8 or higher). + +Download the executable jar file and launch it (probably by double-clicking on it) + +The latest release can always be found here https://github.com/bitkid/itsf-ranking/packages/2052592 and is named itsf-ranking-{version}-all.jar + +### Development + Needs at least JDK 8 and IntelliJ Idea (for Kotlin development) Use `./gradlew check` for running the tests and `./gradlew run` to start the app.