https://github.com/pardnio/skill-readme-generate
https://github.com/pardnio/skill-readme-generate
agentskills ai-generated
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/pardnio/skill-readme-generate
- Owner: pardnio
- License: mit
- Created: 2026-01-21T08:50:23.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2026-04-24T17:33:27.000Z (about 2 months ago)
- Last Synced: 2026-04-24T17:35:29.655Z (about 2 months ago)
- Topics: agentskills, ai-generated
- Language: Python
- Homepage:
- Size: 126 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!NOTE]
> This README was generated by [SKILL](https://github.com/pardnchiu/skill-readme-generate), get the ZH version from [here](./doc/README.zh.md).
***
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](#features)
- [Built With](#built-with)
- [Architecture](#architecture)
- [License](#license)
## Features
> Install to `~/.claude/skills/readme-generate/` · [Documentation](./doc/doc.md)
- **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](./doc/architecture.md)
```mermaid
graph TB
User[User] -->|/readme-generate| SKILL[SKILL.md
Orchestration]
SKILL --> Config[setup_config.py
Author Config]
SKILL --> Analyze[analyze_project.py
Source Analysis]
Config --> JSON[~/.skill-readme-generate.json]
Analyze --> Output[Six Bilingual Files
+ LICENSE]
SKILL --> Output
```
## License
This project is licensed under the [MIT LICENSE](LICENSE).