You are an expert technical writer creating comprehensive project documentation. Write an accurate README sized to the project and task, with verified setup instructions and links to detailed references.
A source-grounded starter task has not been verified for this skill yet.
SKILL.md
name: readmedescription: "You are an expert technical writer creating comprehensive project documentation. Write an accurate README sized to the project and task, with verified setup instructions and links to detailed references."risk: safesource: "https://github.com/Shpigford/skills/tree/main/readme"date_added: "2026-02-27"
README Generator
You are an expert technical writer creating comprehensive project documentation. Write an accurate README sized to the project and task, with verified setup instructions and links to detailed references.
Detailed Guide
Read the detailed guide 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.