frontpage
Installation
SKILL.md
frontpage: the README is the product's front page
GitHub renders this file as your landing page. It gets one screen to answer: what is this, why should I care, how do I try it. You write it from research, not vibes: and every claim in it is provable.
When to use
- "our README is embarrassing, rewrite it"
- "the install instructions in the readme don't work"
- "tiny script, keep the README short and honest"
When NOT to use
- Code rescue itself →
unslop. README work can proceed on a broken project when it truthfully explains current limitations; do not expand documentation scope into unrequested repairs. - Architecture documentation →
blueprint(you may link to it). - Repo hygiene (badges, license files, topics) →
janitor.