docs: apply the shared README house style - #30
Merged
Conversation
Applies a shared README structure used across all nine authorTom project repositories, so someone arriving from one recognises the shape of the next. Canonical section order: # Name -> bold one-sentence pitch -> hero screenshot ## Why it exists the argument: what you did before and why it hurt ## What it does features ## Run it ### With Docker (recommended) / ### From source ## Configuration a table of runtime variables, and what is UI-only instead ## How it's built layout and the decisions worth knowing ## Security where the project handles accounts or data ## Backing up where there is state worth losing ## Licence always last, always spelled this way Also standardised: British English throughout, sentence-case headings with no emoji, no shields.io badges or centred divs, Docker before source in every quick start (the previous order varied), and alt text that describes what is in each screenshot rather than saying "screenshot". Content is preserved rather than rewritten -- this reorganises and normalises the existing material. Drops the three shields.io badges and the emoji from every heading. Moves the screenshot table up to sit directly under the pitch. Keeps the comparison table and the "What SimHub is not (yet)" section intact -- the latter is the most trustworthy paragraph in the file. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Applies a shared README structure used across all nine authorTom
project repositories, so someone arriving from one recognises the shape of
the next.
Canonical section order:
Name -> bold one-sentence pitch -> hero screenshot
Why it exists the argument: what you did before and why it hurt
What it does features
Run it ### With Docker (recommended) / ### From source
Configuration a table of runtime variables, and what is UI-only instead
How it's built layout and the decisions worth knowing
Security where the project handles accounts or data
Backing up where there is state worth losing
Licence always last, always spelled this way
Also standardised: British English throughout, sentence-case headings with
no emoji, no shields.io badges or centred divs, Docker before source in
every quick start (the previous order varied), and alt text that describes
what is in each screenshot rather than saying "screenshot".
Content is preserved rather than rewritten -- this reorganises and
normalises the existing material.
Drops the three shields.io badges and the emoji from every heading. Moves
the screenshot table up to sit directly under the pitch. Keeps the
comparison table and the "What SimHub is not (yet)" section intact -- the
latter is the most trustworthy paragraph in the file.
Part of a nine-repo pass to make the READMEs consistent. Nothing outside the README (and, where noted, a missing
LICENSE) is touched.🤖 Generated with Claude Code