Skip to content

README in hbench's sections; maintainer steps in docs/PUBLISHING.md - #14

Closed
rzonyx wants to merge 1 commit into
mainfrom
readme-standard-sections
Closed

rzonyx wants to merge 1 commit into
mainfrom
readme-standard-sections

Conversation

@rzonyx

@rzonyx rzonyx commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Rewrites the README in hbench's layout (logo, contents, Installation, Usage, Examples, Datasets, reference sections, Development, License, Contributors and contact) and moves the mirror, pin, build and publish steps to docs/PUBLISHING.md. Includes #13's fixes, so it supersedes #13. The examples were run with hbench 0.3.0.

Merge after #7, #9, #10 and #11: they add rows and sections to the README, and I'll fold them into this layout once they're in.

The README follows hbench's layout: a logo, a table of contents, then
Installation, Usage, Examples and Datasets, the reference sections
(environments, verifying, offline use and mirrors, licensing),
Development, License and Contributors and contact. It now says the six
versions are published, needs hbench 0.3.0, and shows export as 0.3.0
takes it.

Mirroring, pinning and building images, images.lock.json and the
publish workflow are maintainer steps, so they move to
docs/PUBLISHING.md, as hbench moved its release steps to
docs/RELEASING.md. CONTRIBUTING points there.
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.

1 participant