docs: complete README.md

This commit is contained in:
Anthony Berg 2024-10-17 20:36:51 +02:00
parent ba1d79d9bf
commit c2ae433c8f

View File

@ -1,3 +1,29 @@
# Kahoot! Challenge
This is the solution for the coding challenge.
This is the solution for the Kahoot! Challenge 2025 created by
Anthony Berg. It was a fun challenge! :)
## Requirements
This has been tested using Java 21, so Java 21 or later is required.
## Running
To run the program, run it from the command line:
```shell
app <file path>
```
This can be run without compiling the application first, by using Gradle:
```shell
./gradlew run --args="example.txt"
```
The example file is provided: [app/example.txt](app/example.txt).
## Compiling
To compile the application, run:
```shell
./gradlew assembleDist
```
And the archive for the application should be located in `app/build/distributions/`.
Then extract the archive and run the app in `app/bin/`.