Skip to content

readme: cut it down - #26

Merged
brianmmaina merged 1 commit into
mainfrom
readme-simplify
Aug 16, 2026
Merged

readme: cut it down#26
brianmmaina merged 1 commit into
mainfrom
readme-simplify

Conversation

@brianmmaina

Copy link
Copy Markdown
Owner

Recovers a commit that was lost in the #24 squash — I amended it and the force-push did not reach GitHub before the merge, so main has the R6 code but not this.

368 lines to 315. The detail that got cut lives in docs/ already, so the README was repeating itself:

  • benchmark commentary from five points to two
  • the crash-safety walkthrough folded into the paragraph explaining why the independent verifier is the part that matters
  • the research section collapsed now that docs/FARMER_2005.md carries the caveats

Also fixes a stale test count (186 → 191, wrong in two places) and gitignores __pycache__/ and *.pdf — the paper PDF was sitting untracked in the working tree and is not mine to redistribute.

The research section is structured so a PDF writeup link drops in next to the docs/FARMER_2005.md one.

368 lines to 315. The detail that got cut is in docs/ already, so the readme
was repeating itself.

Merged the benchmark commentary into two points instead of five, folded the
crash-safety walkthrough into the paragraph that explains why the independent
verifier is the part that matters, and collapsed the research section now that
FARMER_2005.md carries the caveats.

Test count was stale, 186 to 191. Gitignore __pycache__ and pdfs; the paper is
not mine to redistribute.
@brianmmaina
brianmmaina merged commit acfc102 into main Aug 16, 2026
11 checks passed
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