Skip to content

Commit 81b02f0

Browse files
committed
Improve documentation
1 parent a2b82d1 commit 81b02f0

2 files changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,10 @@ Use the `run-libs.sh` script to compare different key-value store libraries:
7878

7979
# Full benchmark using 50% of system RAM
8080
./run-libs.sh benchmark 50
81-
82-
# Full benchmark using 100% of system RAM
83-
./run-libs.sh benchmark 100
8481
```
8582

8683
The benchmark auto-scales based on available RAM and caps at 1 million entries.
87-
Results are written to `target/benchmark/out-libs-1.json` through `target/benchmark/out-libs-6.json`
88-
along with human-readable logs in `target/benchmark/out-libs-1.txt` through `target/benchmark/out-libs-6.txt`.
84+
Results are written to `target/benchmark-libs/`.
8985

9086
#### Version Regression Testing
9187

@@ -97,9 +93,13 @@ Use the `run-vers.sh` script to test LmdbJava performance across versions:
9793

9894
# Full benchmark using 25% of system RAM (default)
9995
./run-vers.sh benchmark
96+
97+
# Full benchmark using 50% of system RAM
98+
./run-vers.sh benchmark 50
10099
```
101100

102101
This tests selected LmdbJava versions from Maven Central plus current development branches to identify performance regressions.
102+
Results are written to `target/benchmark-vers/`.
103103

104104
#### Running Both Benchmark Suites
105105

report-vers.sh

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,8 +370,9 @@ cat >> README.md <<'EOF'
370370
EOF
371371

372372
cat >> README.md <<EOF
373-
The benchmark was executed on ${BENCH_DATE} using the LmdbJava Agrona implementation
374-
with the following configuration:
373+
The benchmark was executed on ${BENCH_DATE} using
374+
[LmdbJava Benchmarks](https://github.com/lmdbjava/benchmarks) with the
375+
LmdbJava Agrona implementation and the following configuration:
375376
376377
### Test Environment
377378

0 commit comments

Comments
 (0)