Skip to content

Make the README a short, uniform guide for newcomers - #61

Merged
liran merged 3 commits into
mainfrom
docs/readme-template
Nov 4, 2026
Merged

liran merged 3 commits into
mainfrom
docs/readme-template

Conversation

@liran

@liran liran commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

The README mixed how to run the tests with long descriptions of each benchmark. It now uses the same seven sections as the other Weir repositories, says who needs this repository and lists the tools and Make targets above a short quick start.

Integration, benchmark, soak and CI detail moved unchanged to docs/, with headings added.

I ran make prepare, make test and make integration locally on macOS arm64 with Docker and without WEIR_TEST_MONGODB_BINARY, the path CI does not use. Remaining gap: a first image download within the 4-minute fixture deadline was not tested, so the quick start pulls the images first.

@liran liran self-assigned this Nov 4, 2026
@liran
liran merged commit 0324add into main Nov 4, 2026
5 checks passed
@liran
liran deleted the docs/readme-template branch November 4, 2026 13:15
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