写好README
从何而来
“README”可能是来自于《爱丽丝漫游仙境》，其中一瓶药水和一个月饼上分别贴着“DRINK ME”（喝我）和“EAT ME”（吃我）的标签。 —— 来自某位读者的提议
正式命名的日期可以追溯到至少 1970 年。不过也有可能是来自更早之前放在打孔卡片上的便签纸，上面潦草地写着的“READ ME!”。
项目都有它的身影
为什么？没有 README 意味着开发者需要阅读源码才能理解你的模块。
对于开发者，项目都是持续集成的，如果没有 README，相隔一段时间，再回来折腾项目，会感觉很陌生。
对于使用者，如果没有 README，就需要耗费大量的时间去解读项目源码，或者带着复杂的心情直接抛弃，找个有 README 提供的项目替代使用。
怎么写
README 的编写质量决定了是否能给人留下好的第一印象。
README 是使用者首先（或唯一）审视你作品的入口。用户希望模块能满足他们的需要，所以你要清楚的说明你的模块的主要作用和优势。
你要做的是：
- 告诉他们这是什么 (使用场景)
- 告诉他们在实际使用中是什么样子
- 告诉他们使用的方法
- 告诉他们其它相关的细节
README 清单
一个有用的清单用来衡量你的 README
- 一句话解释模块的目的
- 必要的背景资料或链接
- 为潜在不熟悉的术语提供到信息来源的链接
- 简洁可运行的实例
- 安装说明
- 详细的 API 文档
- 对认知漏斗的执行
- 前面提到的注意事项和限制
- 不要依赖图片传递关键信息
- 许可证
认知漏斗， 可以想象成是一个直立的漏斗，最宽的部分相关细节最宽泛，越往下移动细节越具体，只有对你的作品足够感兴趣的人才会关注这部分内容。
相关链接
[1] Art of README
[3] standard-readme