readme-generator

Installation
SKILL.md

GitHub README Generator

README 是项目的第一张作品集页面。它不是说明书的目录,也不是功能清单的容器。它要在很短时间内回答三件事:

  1. 这是什么。
  2. 为什么值得看。
  3. 我怎么开始使用。

本 Skill 的目标是生成 100 分 README 作品:清楚、有审美、克制、可信,能让项目像一个完整作品一样被理解。


第一性原理

README 是信任入口和路径入口,不是完整文档。它应该帮助第一次打开仓库的人做出快速判断:

  1. 这个项目解决什么问题。
  2. 它适不适合我。
  3. 我是否能马上运行、安装或继续了解。
Installs
14
GitHub Stars
32
First Seen
Apr 21, 2026
readme-generator — geekjourneyx/readme-generator