[git] 如何编写开源项目的 README 文档

运营一个开源项目就像在运营着一家 Startup，你期待更多人来使用你的项目，并给你的项目加 Star/提交 PR，但好的项目除了其自身真正契合了开发者的需求外，还需要一个好的 README。

有好的 README 文档的项目不一定是一个好开源项目，但一个好开源项目一定有一个好的 README

目前 README 文档编写并没有规范，但一个友好的 README 是有其特征的，我们来看看一个好的 README 的必备要素。README 应该要简短，并且能够节省时间。

完整的 README 应该包括以下：

• 项目和所有子模块和库的名称（对于新用户，有时不同命名会导致混乱）
• 对所有项目，和所有子模块和库的描述
• 如何使用 5-line code（如果是一个库）
• 版权和许可信息（或阅读许可证）
• 抓取文档指令
• 安装、配置和运行程序的指导
• 抓取最新代码和构建它们的说明（或快速概述和「阅读 Install」）
• 作者列表或「Read AUTHORS」
• 提交bug，功能要求，提交补丁，加入邮件列表，得到通知，或加入用户或开发- 开发区群的介绍
• 其他联系信息（电子邮件地址，网站，公司名称，地址等）
• 一个简短的历史记录（更改，替换或者其他）
• 法律声明

还有更详细的请看 Coding https://zhuanlan.zhihu.com/p/23306218