Note

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

---

BILINGUAL READMES AUTO-GENERATED FROM YOUR SOURCE!

---

A Claude Code skill that generates six bilingual docs from source analysis, with private mode, seven licenses, and persistent author config

Table of Contents

• Features
• Built With
• Architecture
• License

Features

Install to ~/.claude/skills/readme-generate/ · Documentation

• Six-File Bilingual Output — One run produces README, doc, and architecture in both English and Traditional Chinese, authored in Chinese first to keep terminology consistent across translations.
• Source-Code-Driven Analysis — analyze_project.py parses exported types, function signatures, and dependencies for Python (AST), Go, JS, and TS; PHP and Swift are detected at file level only.
• Three Orthogonal Parameters — private, LICENSE_TYPE, and REPO_PATH compose freely in any order, defaulting to MIT when no license is specified.
• Persistent Author Config — setup_config.py maintains author, email, and GitHub identity in ~/.skill-readme-generate.json, prompted once interactively then reused across runs.
• Seven Built-In License Templates — MIT, Apache-2.0, GPL-3.0, BSD-3-Clause, ISC, Unlicense, and Proprietary templates are embedded, with Proprietary implying private mode.

Built With

Architecture

Full Architecture

graph TB
    User[User] -->|/readme-generate| SKILL[SKILL.md<br/>Orchestration]
    SKILL --> Config[setup_config.py<br/>Author Config]
    SKILL --> Analyze[analyze_project.py<br/>Source Analysis]
    Config --> JSON[~/.skill-readme-generate.json]
    Analyze --> Output[Six Bilingual Files<br/>+ LICENSE]
    SKILL --> Output

Loading

License

This project is licensed under the MIT LICENSE.