Readme Generate

從原始碼分析自動生成雙語 README。當使用者請求為專案建立 README、需要從程式碼庫生成 README.md（英文）和 README.zh.md（中文）、或希望為其函式庫/套件建立一致的多語言文件時使用。

Install

skills CLI (Claude Code, Cursor, Codex and more)

npx skills add agenvoy/skill-readme-generate --skill readme-generate

Manual install

git clone --depth 1 https://github.com/agenvoy/skill-readme-generate.git /tmp/skill-readme-generate
mkdir -p ~/.claude/skills
cp -r /tmp/skill-readme-generate/. ~/.claude/skills/readme-generate

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# README 產生器

透過分析專案原始碼來生成專業的雙語 README 文件。

## 指令語法

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

### 參數（全部為選填）

| 參數 | 格式 | 範例 | 行為 |
|-----------|--------|---------|----------|
| `private` | 關鍵字 | `private` | 生成時不包含徽章和星標歷史 |
| `LICENSE_TYPE` | 授權識別碼 | `MIT`、`Apache-2.0` | 生成 LICENSE 檔案 |
| `REPO_PATH` | `github.com/{owner}/{repo}` | `github.com/foo/bar` | 覆蓋預設的擁有者/儲存庫 |

### 參數偵測規則

| 模式 | 偵測為 |
|---------|-------------|
| `private`（不區分大小寫） | `PRIVATE_MODE` 旗標 |
| 包含 `github.com/` | `REPO_PATH` |
| 符合已知授權類型（不區分大小寫） | `LICENSE_TYPE` |

**順序獨立**：參數可以任意順序出現。

### 支援的 LICENSE 類型

| 類型 | 別名（不區分大小寫） |
|------|----------------------------|
| 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`（隱含 `private` 模式） |

### 範例

```bash
/readme-generate                                  # 全部重生成 + MIT（若無 LICENSE）
/readme-generate MIT                              # 全部重生成 + MIT LICENSE
/readme-generate private                          # 全部重生成，不含徽章/星標歷史
/readme-generate private MIT                      # 私有模式 + MIT LICENSE
/readme-generate proprietary                      # 私有模式 + Proprietary LICENSE
/readme-generate github.com/foo/bar               # 全部重生成，使用自訂儲存庫路徑
```

---

## Step 0：作者設定（強制性 - 第一步）

**在執行任何動作前，必須先載入或建立作者設定。所有載入與建立都透過 `scripts/setup_config.py` 腳本完成。**

Read the full skill on GitHub

Details

Skill name: readme-generate
Repository: agenvoy/skill-readme-generate
License: MIT
Repo updated: 7 October 2026

FAQ

What does the Readme Generate skill do?

How do I install the Readme Generate skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add agenvoy/skill-readme-generate --skill readme-generate. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Readme Generate popular?

It lives in agenvoy/skill-readme-generate, which has 5 GitHub stars and 0 forks.

Related skills

Six Wise Minds

nightboy87/Six-Wise-Minds-Skill

Use this skill when the user needs help clarifying, stress-testing, comparing, or deciding a fuzzy issue through structured multi-perspective deliberation. Use for product decisions, writing topics, project choices, demand review, personal choices, career reflections, and other decisions where facts, emotions, risks, value, alternatives, and process all matter. Do not use for simple factual lookup, pure translation, pure rewriting, direct code execution, or as final medical/legal/financial/psychological advice.

Writing & Content

Readme

ephemerallyCaden/write-readme

Writes or improves a README (README.md) from codebase analysis, with run commands checked against build files, project screenshots and anti-AI writing rules. The prose avoids the patterns that make a README read as AI-generated. Use when asked to write, generate, create, update or rewrite a project README ("write a readme", "generate a README.md", "update my readme"), to critique, review, audit or improve an existing one ("/readme critique", "review my readme", "improve my readme"), or on "/readme". Supports minimal/standard/detailed verbosity and 20 project types. Screenshots are found in the

Writing & Content

Social Media Scraper

elbis330/social-media-scraper-skill

Skill that pulls and analyzes all data from social media posts. Fetches content from Instagram (reel, post, story), TikTok, Twitter/X and YouTube links. Collects all metadata including text, description, comments, like/share counts, date info, hashtags. Automatically transcribes with faster-whisper and applies visual analysis with Gemini Vision on posts containing video or audio. MANDATORY TRIGGERS: whenever a social media link is shared (instagram.com, tiktok.com, x.com, twitter.com, youtube.com, youtu.be), "read this tweet", "fetch this reel", "analyze this video", "look at this post", "what

Writing & Content

Rankcontrol

rankcontrol/rankcontrol

Operate the user's RankControl workspace (rctrl.com) from the command line - AI search visibility and citations (ChatGPT, Perplexity, Claude, Gemini, Grok, Google AI Mode, Google AI Overviews), SEO content planning, article generation and publishing to their CMS, backlinks and outreach, social repurposing, brand memory, and reports. Use this whenever the user asks about AI visibility, AI citations, GEO/AEO, being cited by ChatGPT, their content calendar, publishing articles, AI traffic attribution, or anything in their RankControl account, even if they don't name RankControl explicitly.

Writing & Content

Ste Writing

1fc0nfig/ste-writing

Rewrite prose (docs, READMEs, PR descriptions, error messages, release notes, comments, commit messages, changelogs - never code) into ASD-STE100 Simplified Technical English to remove "AI slop". Use when asked to make writing not sound like AI, make docs clear or plain, remove slop or fluff from text, enforce a controlled writing style, or write technical documentation that reads human. Two modes - strict (procedures, safety, error messages) and STE-flavored (general prose).

Writing & Content

Project Showcase

ayushxx7/project-showcase-skill

Automate the creation of high-quality project showcases: UI captures, security scans, repo health audits, README injection, GitHub releases, and social media launches.

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.