
Readme Standard
House README standard: structure, badge row, tone, per-archetype templates, and...
Install
npx skills add openclaw/agent-skills --skill readme-standard -g -a claude-code -y- Repository
- openclaw/agent-skills1.1k
- Category
- Engineering
- Updated
- 3d ago
- License
- MIT
- Context cost
- Lightabout 1,406 tokens
- Runs scripts
- No, instructions only
What it does
House README standard: structure, badge row, tone, per-archetype templates, and verification gates for steipete/openclaw repos.
README Standard
One structure for every public README in the steipete and openclaw orgs. Load
this skill before writing or reviewing a README. The reference implementation
is openclaw/fs-safe, read its README
first if unsure what "good" looks like.
The spine
Every README answers, in order, with no detours:
- What is this?, one sentence a stranger understands.
- How do I use it?, smallest real install + a quickstart that proves the pitch.
- Progressively more complex, each section assumes the previous one; deep
reference material moves to
docs/(or the docs site) and gets linked.
Concretely:
# <name> <one emoji>, <playful tagline, one line>
<badge row>
<1, 2 sober sentences: what it is, who it is for. No adjectives doing the work
nouns should do.>
<OPTIONAL: one small code/terminal sample (≤10 lines) that demonstrates the
core value. If one sample can prove the pitch, put it here.>
## Install ← smallest path first (brew/npm/npx), alternatives after
## Quick start ← 60 seconds to first success; commands must actually run
## <core sections> ← 2, 6 sections, each one level deeper than the last
## Development ← build/test/lint in ≤10 lines, link CONTRIBUTING if present
## License ← one line
