readme
You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.
By sickn33 · 450 installs
npx skills add sickn33/agentic-awesome-skills --skill readme
Source repository · Upstream listing
README Generator
You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.
Detailed Guide
Read [the detailed guide](references/detailed guide.md) before executing this skill. It retains the complete procedure and reference material. Treat its safety, prerequisites, and validation requirements as mandatory. For focused work, load the relevant sections; for end to end work, read the guide completely.
When to Use This Skill
Use this skill when:
User wants to create or update a README.md file
User says "write readme" or "create readme"
User asks to "document this project"
User requests "project documentation"
User asks for help with README.md
Limitations
Use this skill only when the task clearly matches the scope described above.
Do not treat the output as a substitute for environment specific validation, testing, or expert review.
Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.