开源项目 README 怎么写？

越来越多的人在 GitHub 上开源自己的项目，创建完项目第一件事就是写 README。那 README 有没有什么标准呢？或者有没有教科书级的 README 参考一下？

GitHub 上有个项目：https://github.com/RichardLitt/standard-readme

看 URL 就知道，这是 RichardLitt 发起的标准 README，目前（2019-09-15）Star 2000+。

README 文件是开源项目的第一个入口。通过 README 明确地告诉大家，这个项目能干什么？怎么安装？以及怎么使用？

因此很多人急需一份标准化的 README 编写方式，帮助你更轻松地创建和维护 REAMDME。所以 Standard Readme 这个项目就诞生了。

一个标准的 README 应该包含下面这些内容：

• Background
• Install
• Usage
  • Generator
• Badge
• Example Readmes
• Related Efforts
• Maintainers
• Contributing
• License

• 项目背景
• 安装
• 使用
  • 生成器
• 徽章引用
• 参考示例
• 相关引用
• 维护者
• 特约/贡献者
• 开源协议