github-readme-cn SKILL.md skillA

github-readme-cn from sanhuang520-ship-it/awesome-chinese-ai-tools is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add sanhuang520-ship-it/awesome-chinese-ai-tools/github-readme-cn@git:20260828.1d100d1

Pins git:20260828.1d100d1 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
sanhuang520-ship-it/awesome-chinese-ai-tools
Path
skills/github-readme-cn/SKILL.md
Versions recorded
4
Latest version
git:20260828.1d100d1, committed Aug 28, 2026
First version recorded
Aug 7, 2026
Size
7,360 bytes
Repository stars
11
License
MIT

中文开源项目的 README 与仓库门面优化。当用户说"我的开源项目没人看""README 怎么写""GitHub 仓库怎么优化""帮我写 README""项目主页太丑""怎么让别人愿意 star"时使用。基于对 15 个近期高增长仓库的实测数据给出可执行建议,同时明确说明哪些是相关性、哪些无法验证——不承诺涨星。.

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

# GitHub 中文项目门面优化

**先说清楚这个技能不做什么:它不能让你的项目火。**

下面的建议来自对 15 个近期高增长仓库的结构实测。这些是**相关性,不是因果**——
我能测到"12/15 首屏有图",但测不到"因为有图所以火"。真正决定传播的是**有没有人替你转发**,
而那个变量不在 README 里。

把门面做好的意义是:**当流量真的来的时候,不至于漏掉。** 仅此而已。

## 什么时候用

写或重写开源项目的 README、仓库描述、topics;项目做完了没人看想找原因;
准备投稿到社区/周刊之前的自查。

---

## 第一步:先问清楚三件事

1. **仓库地址**(有的话直接看现状,没有就问定位)
2. **目标读者是谁**——中文开发者?特定行业?海外?决定语言和例子
3. **这个项目和同类比,凭什么选它**——答不上来的话,README 写得再漂亮也没用

> ⚠️ 用户说"帮我优化 README"时,**不要直接开始写**。
> 先看他现在的 README 和仓库,指出具体差在哪,再动手。凭空写出来的通常是套话。

---

## 首屏是唯一重要的位置

GitHub 上不滚动能看到的大约是 **README 前 15 行**。绝大多数人只看这一屏。

### 实测:15 个高增长仓库的首屏

| 特征 | 命中 | 说明 |
|------|------|------|
| **首屏有图** | **12/15** | 最普遍的一条 |
| 首屏有徽章 | 11/15 | shields.io |
| 首屏有安装命令 | 4/15 | 少见,但对工具类很有用 |
| 首屏能点到 demo | 3/15 | 少见,做了就是差异化 |
| 标题用中文 | 2/15 | 即便是中文项目也多用英文名 |

**中位数参考**:README 15 KB · 图片 10 张 · 仓库名 14 字符 · topics 9 个

### 首屏该有的东西,按顺序

```markdown
<div align="center">
  <img src="真实产品截图或效果图" width="100%">

  # 项目名

  **一句话说清楚它给你什么**(不是"这是一个基于 XX 的 YY 框架")

  [徽章] [徽章] [徽章]

  [🌐 在线体验] · [📋 文档] · [📸 效果图]
</div>

> **和同类比有什么不一样**
> ① …… ② …… ③ ……

```bash
一行就能跑起来的命令
```
```

---

## 关于首屏那张图

**用真实产出,不要用设计稿或抽象插画。**

如果你的项目输出是可视的(网页、图表、CLI 界面、渲染结果),
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add sanhuang520-ship-it/awesome-chinese-ai-tools/github-readme-cn@sha256:5ace90a50ffb3b81

The line at the top of this page pins the label git:20260828.1d100d1, 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_v7pcnowvagge5gm6.svg)](https://markdownregistry.com/a/art_v7pcnowvagge5gm6)

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

Versions

The registry has recorded 4 versions of this file, between Aug 7, 2026 and Aug 28, 2026, about one every 7 days.

versioncommittedcommitsizeaudit
git:20260828.1d100d1 latest2026-08-28 1d100d1 7,360 BA view · diff
git:20260812.8dc2f6e2026-08-12 8dc2f6e 6,967 BA view · diff
git:20260807.6f7091e2026-08-07 6f7091e 6,851 BA view · diff
git:20260807.8ee005f2026-08-07 8ee005f 6,670 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 (7360 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

sanhuang520-ship-it/awesome-chinese-ai-tools · 11 stars · license MIT · pushed 2026-11-02 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_v7pcnowvagge5gm6
GET https://markdownregistry.com/api/v1/resolve?ref=sanhuang520-ship-it/awesome-chinese-ai-tools/github-readme-cn
GET https://markdownregistry.com/api/v1/blob/5ace90a50ffb3b81fb01538ecf0601bdf5a92f143f78e963416768303d0e7370

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.

More from sanhuang520-ship-it/awesome-chinese-ai-tools

DESIGN.md DESIGN.md file
sanhuang520-ship-it/awesome-chinese-ai-tools · DESIGN.md
git:20260812.f828705 · audit A · 11 stars
llms.txt llms.txt file
sanhuang520-ship-it/awesome-chinese-ai-tools · llms.txt
git:20260914.683ae36 · audit A · 11 stars
ai-learning-coach SKILL.md skill
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/ai-learning-coach/SKILL.md · 用 AI 系统学习任何东西的教练。当用户要"学 XX""怎么入门""帮我制定学习计划""我想搞懂 XX""考证/备考""复习"时使用。不是直接讲答案,而是带着走完整的学习循环:定目标→输入→主动回忆→输出→纠错→间隔复习→项目交付。
git:20260812.8dc2f6e · audit A · 11 stars
book-digest-cn SKILL.md skill
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/book-digest-cn/SKILL.md · 中文拆书与读书笔记助手。当用户要"拆书""读书笔记""这本书讲什么""帮我读这本书""做读书卡片""写书评""整理一本书的框架"时使用。重点是把书变成能用的东西,不是复述目录。
git:20260812.8dc2f6e · audit A · 11 stars
bookkeeping-cn SKILL.md skill
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/bookkeeping-cn/SKILL.md · 中文记账与账目整理助手。当用户要"记账""整理流水""做收支表""对账""分类消费""做预算""看看钱花哪了"时使用。只做数据整理与呈现,不提供税务筹划或投资建议。
git:20260812.8dc2f6e · audit A · 11 stars
chinese-design-md SKILL.md skill
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/chinese-design-md/SKILL.md · 中式 DESIGN.md 设计系统。当用户要"中国风网页""国风页面""中式设计系统""给项目定个中式风格""DESIGN.md""让 AI 按设计规范生成界面""中文网页排版规范"时使用。提供 8 套可直接丢进项目根目录的…
git:20260812.8dc2f6e · audit A · 11 stars
DESIGN.md@skills/chinese-design-md/design-md/azurite DESIGN.md file
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/chinese-design-md/design-md/azurite/DESIGN.md · 石青与石绿的矿物色,取自《千里江山图》的色彩体系。装饰性强,适合文旅、展览、需要「贵气」的场景。 Azurite and malachite mineral pigments, drawn from the color system of…
v1 · audit A · 11 stars
DESIGN.md@skills/chinese-design-md/design-md/bamboo DESIGN.md file
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/chinese-design-md/design-md/bamboo/DESIGN.md · 竹青与素白,清爽。适合健康、教育、环保、任何想显得「干净有生气」的场景。 Bamboo green and plain white. Fresh and clean.
v1 · audit A · 11 stars
DESIGN.md@skills/chinese-design-md/design-md/dunhuang DESIGN.md file
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/chinese-design-md/design-md/dunhuang/DESIGN.md · 土红、石青、土黄,带斑驳的壁画质感。最有故事感的一套,适合文化 IP、展览、叙事型页面。 Earthy ochre, azurite and clay yellow with weathered mural texture. The…
v1 · audit A · 11 stars
DESIGN.md@skills/chinese-design-md/design-md/ink DESIGN.md file
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/chinese-design-md/design-md/ink/DESIGN.md · 宣纸的米白、墨的层次、大量留白。最克制的一套,适合长文阅读、文化类内容、需要「安静」的界面。 Rice-paper off-white, graded ink tones, generous emptiness. The most…
v1 · audit A · 11 stars
DESIGN.md@skills/chinese-design-md/design-md/neo DESIGN.md file
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/chinese-design-md/design-md/neo/DESIGN.md · 木色与暖灰,低饱和,线条简洁。最百搭的一套,适合家居、生活方式、品牌官网。 Wood tones and warm greys, low saturation, clean lines. The most versatile set.
v1 · audit A · 11 stars
DESIGN.md@skills/chinese-design-md/design-md/night DESIGN.md file
sanhuang520-ship-it/awesome-chinese-ai-tools · skills/chinese-design-md/design-md/night/DESIGN.md · 深色底配暖金,唯一一套深色主题。适合影音、夜间模式、高端活动、需要「戏剧感」的页面。 Dark ground with warm gold — the only dark theme in this set. Cinematic and…
v1 · audit A · 11 stars

Every file in sanhuang520-ship-it/awesome-chinese-ai-tools

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