readme – Writing & Content skill for AI agents
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.
Install the readme skill with one command
Pick the tool you use, copy the command and paste it in your terminal. The skill lands in that tool's skills folder and is ready in your next session.
Claude Code
mkdir -p ~/.claude/skills && curl -fsSL https://skill.dn1nguoi.com/z/readme-933b5.tgz | tar xz -C ~/.claude/skills
Call it in Claude Code: /readme – then describe the task you want done.
Codex
mkdir -p ~/.codex/skills && curl -fsSL https://skill.dn1nguoi.com/z/readme-933b5.tgz | tar xz -C ~/.codex/skills
Call it in Codex: $readme – then describe the task you want done.
Hermes Agent
mkdir -p ~/.hermes/skills && curl -fsSL https://skill.dn1nguoi.com/z/readme-933b5.tgz | tar xz -C ~/.hermes/skills
Call it in Hermes Agent: /readme – then describe the task you want done.
DeepSeek
mkdir -p ~/.deepcode/skills && curl -fsSL https://skill.dn1nguoi.com/z/readme-933b5.tgz | tar xz -C ~/.deepcode/skills
Call it in DeepSeek: /readme – then describe the task you want done.
SKILL.md content
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](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.
Related skills
- renhua – Write Chinese social posts and product copy in a real person's voice, removing AI tells…
- report-writing – Bug bounty report writing for H1/Bugcrowd/Intigriti/Immunefi
- repurpose-into-a-post – Turn an article, newsletter, transcript or video into a Twitter/X or LinkedIn post that…
- rex – Translates user intent into a precise, unambiguous specification and requirements.
- robius-event-action – CRITICAL: Use for Robius event and action patterns. Triggers on: custom action…
- same-idea-both-platforms – Write one idea as a Twitter/X post and a LinkedIn post that read as written separately…
- schema-markup-generator – Generate and implement JSON-LD structured data for web apps, blogs, FAQs, and SaaS…
- screenstudio-alt – Open-source headless Screen Studio alternative: auto speed-up of idle, auto-zoom on…