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

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

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

目前 README 文档编写并没有规范，但一个友好的 README 是有其特征的，我们来看看一个好的 README 的必备要素。

国际化问题

项目名及简介

• 这个开源项目是做什么的？
• 这个项目是什么语言编写的？
• 项目维护、CI、依赖更新状态（如果有）
• 项目可用版本及其他版本
• Demo 或官网地址（如果有）

项目 Logo 和使用截图

功能

你可以注明这个项目的功能特点，亮点特色会大大提高访客使用这个项目的概率。

用法

这是 README 中最重要的部分，你需要说明这个项目如何使用，这包括：

• 如何下载这个项目：一般情况下 git clone 该项目地址即可，当然你也可以提供其他包管理下载安装方式；
• 项目依赖：你需要说明编译运行这个项目前需要哪些依赖；
• 安装：你需要说明如何编译安装/运行这个项目；
• 部署：如果这个项目可以部署的话，请最好注明部署要注意的事项；
• Debug 方法：理想状况下，你的用户会顺利编译并运行这个项目，但你要确保用户遇到了问题不会来打扰你（如提交 Issues），你还需要提供用户可能会遇到的常见问题；

贡献

对于一个开源项目来说，令其作者最开心的莫过于有人提交 Pull Request 了。加入一个 CONTRIBUTING 文档将大大提高他人贡献你的项目的概率。

版权

鸣谢

你还可以感谢直接或间接为这个项目做出贡献的人、项目。

其他

这就是一个好的 README 所需元素了，当然你还可以增加其他任何利于开发者的信息如 Roadmap 等等，这因项目而异。现在，去完善你的开源项目信息或开始做一个开源项目吧！

Happy Coding ; )

（完）

你可能会感兴趣的文章：