README Generator

Write README files that help the right reader succeed quickly. This skill prioritizes fast orientation, copy-pasteable setup steps, accurate command examples, honest architecture summaries, and contribution guidance that reflects the repository instead of generic template filler.

When to Use

• Creating a README for a new repository, package, service, or CLI
• Rewriting a vague or outdated README into something actionable
• Documenting install, run, test, build, deploy, or contribution workflows
• Aligning README depth to the intended audience: users, contributors, or operators
• Standardizing README structure across multiple repos
• Improving repository first impression and onboarding speed

Workflow