docs: README

This commit is contained in:
Daniel Langbein 2024-12-30 16:49:40 +00:00
parent 798ed8502c
commit 21940b29df
Signed by: langfingaz
GPG Key ID: 6C47C753F0823002

View File

@ -4,7 +4,7 @@
### Setup ### Setup
Dependencies (JDK23, Gradle, IntelliJ) can be installed by running `nix-shell`. The development dependencies (JDK23, Gradle, IntelliJ) can e.g. be installed with `nix` by running `nix-shell`.
**Commandline** **Commandline**
@ -28,7 +28,7 @@ This should include version >= 23, e.g.:
**IntelliJ** **IntelliJ**
When using `nix-shell`, some configuration is necessary: When using `nix-shell`, some manual configuration is necessary:
- STRG ALT SHIFT s -> SDK -> add JDK -> - STRG ALT SHIFT s -> SDK -> add JDK ->
- home path: /usr/lib/openjdk - home path: /usr/lib/openjdk
@ -56,3 +56,12 @@ Run the task "test":
```shell ```shell
./gradlew test ./gradlew test
``` ```
### Benchmark
There are two different benchmarks. One is based on the JMH benchmark framework, the other one is a custom benchmark implementation.
```shell
./gradlew jmh
./gradlew runCustomBenchmark
```