Skip to content

README in plainer words - #170

Merged
kvignesh1420 merged 1 commit into
mainfrom
readme-plain
Nov 16, 2026
Merged

kvignesh1420 merged 1 commit into
mainfrom
readme-plain

Conversation

@kvignesh1420

@kvignesh1420 kvignesh1420 commented Nov 16, 2026 •

Copy link
Copy Markdown
Collaborator

Rewrites the README's prose to be simpler and easier to follow. Code blocks, tables of options, numbers and links are unchanged.

  • All 22 semicolons are gone, split into shorter sentences. There were no em dashes.
  • Dense paragraphs are now short lists: column options, how a column follows its causes, the two seeds of realize and sample, and saving and inspecting.
  • Shorthand is spelled out: "a time cut" is now "a cut in time", and the option tables say what each option does in plain words, e.g. prefer reads "Parents with more beds are picked more often".

pixi run examples passes: every README block runs, together and on its own.

@kvignesh1420
kvignesh1420 merged commit 5133440 into main Nov 16, 2026
5 checks passed
@kvignesh1420
kvignesh1420 deleted the readme-plain branch November 16, 2026 23:52
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