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 NOT to use
- The codebase itself is the mess →
unslopfirst; a great README on a broken project is a lie with formatting. - Architecture documentation →
blueprint(you may link to it). - Repo hygiene (badges, license files, topics) →
janitor.
Prerequisites
Research before writing anything (the PRD rule: understand the actual project):