README Generator Skill

English | 中文

readme-generator is a README authoring skill for Codex and Claude Code. It analyzes repository evidence first, then generates or rewrites a more accurate README.md based on project type, task mode, and documentation density, while reducing common hallucinations around badges, install commands, API examples, and unsupported claims.

Use Cases

• Generate a new README from scratch
• Refactor an existing README
• Generate only one section, such as Quick Start or API
• Simplify an overly detailed README into a minimal version
• Prepare a more release-ready README for open source projects

Capabilities

• Evidence-first README writing
• Supports greenfield, refactor, partial, and release
• Supports minimal, standard, and extended
• Automatically treats "the README is too complex" as a simplification request
• Enforces evidence-backed badges, install commands, URLs, and API descriptions

Repository Layout

.
├── README.md
├── README.zh-CN.md
├── LICENSE
├── install-codex.sh
├── install-claude-code.sh
└── readme-generator/
    └── SKILL.md

One-Click Install for Codex

Option 1: use the repo installer script

curl -fsSL https://raw.githubusercontent.com/Moosphan/readme-generator/main/install-codex.sh | bash

Option 2: use Codex's built-in GitHub skill installer

python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
  --repo Moosphan/readme-generator \
  --path readme-generator

Restart Codex after installation.

One-Click Install for Claude Code

curl -fsSL https://raw.githubusercontent.com/Moosphan/readme-generator/main/install-claude-code.sh | bash

Restart Claude Code after installation.

Claude Code personal skills are typically installed under ~/.claude/skills/.

Manual Install

Codex

Copy readme-generator/ to:

~/.codex/skills/readme-generator/

Claude Code

Copy readme-generator/ to:

~/.claude/skills/readme-generator/

Example Prompts

• "Rewrite this repository README"
• "This README is too long. Make it minimal."
• "Generate only Quick Start and installation."
• "Prepare a release-ready README for this open source project."

License

MIT