Note

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

readme-generate

A Claude Code skill that auto-generates bilingual READMEs from source code analysis, supporting private mode and multiple license types
This project was primarily generated by Claude Code, with minor adjustments by the author.

Table of Contents

• Features
• Installation
• Usage
• CLI Reference
• License

Features

Source-Code-Driven Content Extraction

Runs the built-in analyze_project.py script to scan actual project files (package.json, go.mod, pyproject.toml, etc.) and extract real package names, versions, and dependency information. Generated README content comes from the codebase itself rather than manual input, keeping documentation in sync with the actual source code.

Flexible Parameterized Control

Supports three optional parameters in any order: the private flag hides public badges and star history for internal projects; LICENSE_TYPE generates a LICENSE file from seven supported types (MIT, Apache-2.0, GPL-3.0, BSD-3-Clause, ISC, Unlicense, Proprietary); and REPO_PATH in github.com/owner/repo format overrides the auto-detected owner and repository name. All three parameters can be freely combined.

Four-File Bilingual Documentation Strategy

Each run produces four files: concise README.md (English) and doc/README.zh.md (Traditional Chinese) that showcase three core features to attract readers, plus detailed doc/doc.md and doc/doc.zh.md that cover installation, configuration, usage, and CLI reference. Chinese is authored first to ensure terminological consistency, then translated to English.

Installation

Place this skill in the Claude Code skills directory:

~/.claude/skills/readme-generate/

Directory structure:

readme-generate/
├── scripts/
│   └── analyze_project.py    # Source code analysis script
├── SKILL.md                  # Skill definition file
├── LICENSE
├── README.md
└── README.zh.md

Usage

/readme-generate [private] [LICENSE_TYPE] [REPO_PATH]

Examples

# Generate README only (public mode)
/readme-generate

# README + MIT LICENSE
/readme-generate MIT

# Private mode (no badges or star history)
/readme-generate private

# Private README + MIT LICENSE
/readme-generate private MIT

# Custom repository path
/readme-generate github.com/foo/bar

# Private README + custom path + license
/readme-generate private MIT github.com/foo/bar

CLI Reference

Parameters

Parameter	Format	Description
private	Keyword (case-insensitive)	Hide badges and star history
LICENSE_TYPE	License identifier	Generate corresponding LICENSE file
REPO_PATH	github.com/{owner}/{repo}	Override auto-detected owner and repository

Supported License Types

Type	Aliases (case-insensitive)
MIT	mit
Apache-2.0	apache, apache2, apache-2.0
GPL-3.0	gpl, gpl3, gpl-3.0
BSD-3-Clause	bsd, bsd3, bsd-3-clause
ISC	isc
Unlicense	unlicense, public-domain
Proprietary	proprietary (implies private mode)

Parameter Detection Rules

Pattern	Detected As
private (case-insensitive)	PRIVATE_MODE flag
Contains github.com/	REPO_PATH
Matches known license type	LICENSE_TYPE

Output Files

File	Description
README.md	English primary documentation (concise, 3-feature driven)
doc/README.zh.md	Traditional Chinese version (concise, 3-feature driven)
doc/doc.md	English detailed technical documentation
doc/doc.zh.md	Traditional Chinese detailed technical documentation
LICENSE	Generated by specified type; defaults to MIT if unspecified

License

This project is licensed under the MIT LICENSE.