很多开发者在Github上创建一个项目的时候，往往忽视了Readme的重要性，实际上，Readme文件通常是你开源项目的第一个入口点，它的作用主要有告诉人们为什么应该使用你的项目，以及如何安装和使用，一份标准化的Readme可以简化它的创建和维护。
很多开发者在Github上创建一个项目的时候，往往忽视了Readme的重要性，实际上，Readme文件通常是你开源项目的第一个入口点，它的作用主要有告诉人们为什么应该使用你的项目，以及如何安装和使用，一份标准化的Readme可以简化它的创建和维护，所以Readme值得你花时间去创建。
今天，猿妹和大家分享一个教科书般的Readme——standard-readme，目前该项目在Github上已经标星2.3K，605个Fork。（Github地址：https://github.com/RichardLitt/standard-readme）
这个库包含：
- 定义标准的Readme规范
- 应该有一个linter来维护Readme
- 创建标准readme的生成器
- Badge
- 标准Readme中的示例
标准Readme是为开源库设计的。尽管它以前用于Node和npm项目，但它也适用于其他语言的库和包管理器。
背景
项目背景就是你为什么做这个项目，动机和背景是什么。当其他开发者无需查看模块代码就可以使用你的项目时，你的文档即已完成，这意味着你可以将模块的文档化接口与内部实现分开，所以只要接口保持不变，你就可以自由更改模块内部代码。
安装
该项目需要你安装node和npm，如下：
- $npminstall--globalstandard-readme-spec
Generator
使用Generator，请查看generator-standard-readme。该程序包中有一个全局可执行文件来运行生成器，别名为standard-readme。（Github地址：https://github.com/RichardLitt/generator-standard-readme）
Badge
如果你的Readme符合标准要求，并且你使用的是Github，那么使用Badge就会很有用，如果要以Markdown格式添加，请使用以下代码：
- [](https://github.com/RichardLitt/standard-readme)
维护者
你可以直接@该项目相关的维护者，这样其他人也可以轻易联系到他
贡献者
创建一个项目不容易，最后还是要感谢一下所有的贡献者。
License
最后的最后你需要声明项目的开源协议，不同的开源协议的限制条件是不一样的，这就需要你自己查阅相关条款，选择一个最适合自己项目的开源协议。
©本文为清一色官方代发，观点仅代表作者本人，与清一色无关。清一色对文中陈述、观点判断保持中立，不对所包含内容的准确性、可靠性或完整性提供任何明示或暗示的保证。本文不作为投资理财建议，请读者仅作参考，并请自行承担全部责任。文中部分文字/图片/视频/音频等来源于网络，如侵犯到著作权人的权利，请与我们联系（微信/QQ:1074760229）。转载请注明出处：清一色财经
微信扫码打赏 
支付宝扫码打赏 
