From df26347fbbdfa08a0e538a6c4cd7a26e1ed4c093 Mon Sep 17 00:00:00 2001
From: Daniel Langbein <daniel@systemli.org>
Date: Tue, 31 Dec 2024 14:21:14 +0000
Subject: [PATCH] docs: README

---
 README.md | 40 ++++++++++++++++++++++++++++------------
 1 file changed, 28 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index b4c8fa5..b20670e 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
 # Bring Powersort to Java
 
-## Gradle
+Implementation of Powersort with the aim of integrating it into OpenJDK. Benchmarks are used to ensure that the runtime of the new sorting algorithm is never slower than the current Timsort implementation.
 
-### Setup
+## Setup
 
-The development dependencies (JDK23, Gradle, IntelliJ) can e.g. be installed with `nix` by running `nix-shell`.
+We use Gradle for dependency and build management.
 
 **Commandline**
 
@@ -26,18 +26,34 @@ This should include version >= 23, e.g.:
      | Detected by:        Current JVM
 ```
 
+### Development Setup with nix
+
+The provided [shell.nix](shell.nix) file can be used to set up a development environment with IntelliJ. The only prerequisite is to have a working `nix` installation for which there are multiple possibilities, e.g:
+
+```shell
+# https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#determinate-nix-installer
+curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | \
+  sh -s -- install
+```
+
+Then the dependencies (JDK23, Gradle, IntelliJ) can be installed with:
+
+```shell
+nix-shell
+```
+
 **IntelliJ**
 
 When using `nix-shell`, some manual configuration is necessary:
 
-- STRG ALT SHIFT s -> SDK -> add JDK ->
-    - home path: /usr/lib/openjdk
-    - name: usr-lib-jdk
-- STRG ALT s -> build tools -> gradle ->
-    - local installation: /usr/lib/gradle
-    - Gradle JVM: usr-lib-jdk
+- `STRG` `ALT` `SHIFT` `s` -> SDK -> add JDK ->
+    - home path: `/usr/lib/openjdk`
+    - name: `usr-lib-jdk`
+- `STRG` `ALT` `s` -> build tools -> gradle ->
+    - local installation: `/usr/lib/gradle`
+    - Gradle JVM: `usr-lib-jdk`
 
-### Tasks
+## Tasks
 
 List all Gradle tasks which can be run:
 
@@ -49,7 +65,7 @@ This can also be done graphically in IntelliJ:
 
 ![intellij-gradle.png](intellij-gradle.png)
 
-### Test Cases
+## Test Cases
 
 Run the task "test":
 
@@ -57,7 +73,7 @@ Run the task "test":
 ./gradlew test
 ```
 
-### Benchmark
+## Benchmark
 
 There are two different benchmarks. One is based on the JMH benchmark framework, the other one is a custom benchmark implementation.