github-readmelisted
Install: claude install-skill mickpletcher/AI-Skills
# GitHub README Skill
## Intent
Create or improve README files that accurately explain what a repo does, how to run it, and how a practical user should start.
## Do Not Use When
- Do not use when the user wants code implementation, PR review, repo architecture, or docs that are not tied to live repo behavior.
- Required context is missing and cannot be reasonably inferred.
- A more specific skill in this repo is a better match.
## Constraints
- Do not fabricate missing facts, measurements, dates, sources, or user context.
- Keep output aligned with Mick's direct, practical communication style unless the skill says otherwise.
- Preserve safety, legal, medical, financial, and operational boundaries stated in this file.
- Prefer concise, usable output over broad explanation.
## Validation Checklist
- [ ] The output matches the skill's intended task and platform.
- [ ] Required inputs, assumptions, and uncertainty are explicit.
- [ ] Safety, scope, and source limits are respected.
- [ ] The response follows the requested format or the skill's default output format.
- [ ] The result is practical enough to use without another cleanup pass.
Write polished, complete `README.md` files for GitHub repositories in a direct, technical, practitioner-focused voice.
## Primary Triggers
Use this skill when the user starts with `readme` or `gr`, or asks to write, rewrite, or document a repository README.
```text
readme [paste repo description, file