Skip to content

docs: Refresh README quick start and benches list - #362

Merged
apaolillo merged 1 commit into
mainfrom
readme
Jul 23, 2026
Merged

docs: Refresh README quick start and benches list#362
apaolillo merged 1 commit into
mainfrom
readme

Conversation

@apaolillo

Copy link
Copy Markdown
Collaborator

Link the new project website (benchkit.dev) and add a canonical quick start: pip install plus the runnable version of Listing 1 of the ICPE 2026 paper, using the current campaign API (top-level CampaignCartesianProduct, LevelDBBench with bench_name as a variable). The README previously showed no campaign example at all, while the paper, the website, and the reproduction artifact all showcase this one.

Rewrite the supported-benchmarks section to match reality: SPEC CPU 2017 and SPEC CPU 2026 first, the full benchkit.benches roster (NPB, Graph500, Splash-4, VolanoMark, ...), and the examples/ integrations listed separately; drop the stale TODO markers.

Point Getting Started at the ICPE reproduction artifact (9 verified examples on the current API) and mark the tutorials and examples/ integrations as legacy campaign API, with a matching notice in both tutorial READMEs.

Link the new project website (benchkit.dev) and add a canonical quick
start: pip install plus the runnable version of Listing 1 of the ICPE
2026 paper, using the current campaign API (top-level
CampaignCartesianProduct, LevelDBBench with bench_name as a variable).
The README previously showed no campaign example at all, while the
paper, the website, and the reproduction artifact all showcase this one.

Rewrite the supported-benchmarks section to match reality: SPEC CPU 2017
and SPEC CPU 2026 first, the full benchkit.benches roster (NPB,
Graph500, Splash-4, VolanoMark, ...), and the examples/ integrations
listed separately; drop the stale TODO markers.

Point Getting Started at the ICPE reproduction artifact (9 verified
examples on the current API) and mark the tutorials and examples/
integrations as legacy campaign API, with a matching notice in both
tutorial READMEs.

Signed-off-by: Antonio Paolillo <apaolill@gmail.com>
@apaolillo
apaolillo requested a review from EstAK July 22, 2026 12:55
@apaolillo apaolillo self-assigned this Jul 22, 2026
@apaolillo
apaolillo merged commit 6491e2b into main Jul 23, 2026
2 checks passed
@apaolillo
apaolillo deleted the readme branch July 23, 2026 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants