github-readme

Installation
SKILL.md

GitHub README 写作规范

本 Skill 有两个来源:

  • uv、shadcn/ui、Supabase、Astro、Tailwind 等高星仓库的 README 范式。
  • answer-me-with-html 一个仓库里 50 多次 README 提交、两次瘦身、维护者在 GitHub 网页上亲手做的修改。规则后面括号里的「实战」就是从那里来的。

核心只有三条:说人话;读者 3 秒看懂首屏;README 只回答四件事。

下文的 scripts/、references/、assets/ 都相对于本 skill 的目录,不是目标仓库。


零、先分任务

先判断用户要做哪一种,再按对应的流程走。拿不准就问。

Installs
1
First Seen
Oct 9, 2026