Note

This README was generated by SKILL, get the ZH version from here.

skill-readme-generate

A Claude Code skill that generates bilingual READMEs for Skill projects by reading SKILL.md and producing structured, spec-compliant documentation
This project was primarily generated by Claude Code, with minor adjustments by the author.

Table of Contents

• Features
• Installation
• Usage
• CLI Reference
• License

Features

Skill-Aware README Generation

Generates READMEs tailored specifically for Claude Code Skill projects by reading SKILL.md directly. Unlike generic README generators, it understands skill-specific structures — command syntax, trigger conditions, and section ordering — and surfaces them in the right places.

Bilingual Output from a Single Command

Produces both README.md (English) and README.zh.md (Traditional Chinese) in one pass, with Chinese written first and English translated from it. This ensures terminological consistency across both languages without manual cross-editing.

Standardized Structure Across All Skill Projects

Enforces a consistent section order — Features, Installation, Usage, CLI Reference, License — across every Skill README it generates. Developers browsing multiple skills can navigate any README without re-learning the layout.

Installation

Place this skill in the Claude Code skills directory:

~/.claude/skills/skill-readme-generate/

Directory structure:

skill-readme-generate/
├── SKILL.md              # Skill definition file
├── LICENSE
├── README.md
└── README.zh.md

Usage

/skill-readme-generate

Examples

# Run in any Claude Code Skill project directory
/skill-readme-generate

CLI Reference

Output Files

File	Language	Description
README.md	English	Primary documentation
README.zh.md	Traditional Chinese	Chinese documentation
LICENSE	-	MIT LICENSE (auto-generated if missing)

License

This project is licensed under the MIT LICENSE.