程序员如何写好 README：让项目自己说话

GitHub 上看到一个项目，第一眼看的就是 README。

README 写得好，项目成功一半。

一、README 应该包含什么

必要内容

1. 一句话描述：这个项目是干什么的
2. 核心功能：用一句话列表
3. 快速开始：3 步让你的项目跑起来
4. 效果截图：让用户看到成品

可选内容

• 适用场景
• 技术栈
• 贡献指南
• License
• 联系方式

二、README 的常见错误

❌ 太长

README 不是手册，是广告。

控制在 5 分钟能看完。

❌ 只有文字

代码高亮、截图、图表，比文字更直观。

❌ 代码示例不完整

"参考官方文档"——这句话等于没写。

给一个能跑起来的最小示例。

三、好 README 的模板

# 项目名

一句话描述（不超过 20 字）

## 效果截图

## 核心功能

- 功能1
- 功能2
- 功能3

## 快速开始

```bash
npm install xxx
xxx run start

适用场景

适合用这个的人：XXX

License

MIT

---

## 四、一句话总结

> **README 是项目的门面，花 30 分钟好好写，值得**。

---

**标签**: GitHub, README, 开源, 项目文档, 程序员