Home / agenvoy / skill-readme-generate · GitHub

readme-generate SKILL.md skillA

readme-generate from agenvoy/skill-readme-generate is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add agenvoy/skill-readme-generate/readme-generate@git:20261007.e8a7ff1

Pins git:20261007.e8a7ff1 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
agenvoy/skill-readme-generate
Path
SKILL.md
Versions recorded
8
Latest version
git:20261007.e8a7ff1, committed Oct 7, 2026
First version recorded
Jul 5, 2026
Size
43,609 bytes
Repository stars
5
License
MIT

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

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# 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                          # 全部重生成，不含徽章/星標歷史
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add agenvoy/skill-readme-generate/readme-generate@sha256:e286175d91852784

The line at the top of this page pins the label git:20261007.e8a7ff1, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_lgyksevsekmjcnib.svg)](https://markdownregistry.com/a/art_lgyksevsekmjcnib)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 8 versions of this file, between Jul 5, 2026 and Oct 7, 2026, about one every 13 days.

versioncommittedcommitsizeaudit
git:20261007.e8a7ff1 latest2026-10-07 e8a7ff1 43,609 BA view · diff
git:20261005.4df0f152026-10-05 4df0f15 42,925 BA view · diff
git:20261004.56955252026-10-04 5695525 40,741 BA view · diff
git:20260921.69a03352026-09-21 69a0335 39,730 BA view · diff
git:20260921.45cb0622026-09-21 45cb062 46,275 BA view · diff
git:20260707.43673e82026-07-07 43673e8 41,853 BA view · diff
git:20260707.fcad9e32026-07-07 fcad9e3 41,857 BA view · diff
git:20260705.56a7daf2026-07-05 56a7daf 42,259 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (43609 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

agenvoy/skill-readme-generate · 5 stars · license MIT · pushed 2026-10-07 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_lgyksevsekmjcnib
GET https://markdownregistry.com/api/v1/resolve?ref=agenvoy/skill-readme-generate/readme-generate
GET https://markdownregistry.com/api/v1/blob/e286175d9185278498cfeb3fa2325409255b2ba2264a410dbe8d2b063977fe1f

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

Browse by kind, by grade A, or by owner.