From 21940b29dfd185603f3fb65be657973bb68c1898 Mon Sep 17 00:00:00 2001 From: Daniel Langbein Date: Mon, 30 Dec 2024 16:49:40 +0000 Subject: [PATCH] docs: README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7c50e36..b4c8fa5 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ### 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** @@ -28,7 +28,7 @@ This should include version >= 23, e.g.: **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 -> - home path: /usr/lib/openjdk @@ -56,3 +56,12 @@ Run the task "test": ```shell ./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 +```