Skip to content
oss-kit
GitHubInstall

The README shows how to install the project and one runnable example, in that order, near the top

Rule
R-DOC-02
Forge scope
GitHub and GitLab
Fixed by
oss-readme

Installation and a working snippet answer the two questions every visitor has. Burying them under motivation, philosophy, or comparison tables costs you the readers who would have used the project.

Observable check

README.md contains a fenced code block with an install command, followed by a second fenced code block showing minimal usage, and both appear before any section about design, motivation, or comparisons.

Read the whole standard