很多开发者在Github上创建项目的时候，往往忽略了Readme的重要性。事实上，Readme文件通常是你的开源项目的第一个入口，它的主要作用是告诉人们你为什么要使用你的项目，以及如何安装和使用它。标准化的Readme可以简化其创建和维护，因此Readme值得您花时间创建。今天元美给大家分享一本教科书式的Readme——standard-readme。目前，该项目在Github上有2.3Kstars和605Forks。（Github地址：https://github.com/RichardLitt/standard-readme）这个库包含：定义标准的Readme规范应该有一个维护Readme的linter创建StandardReadmeBadge的生成器StandardReadme中的例子标准自述文件用于开源库设计。虽然它以前用于Node和npm项目，但它也适用于其他语言的库和包管理器。Background项目背景就是你为什么做这个项目，你的动机和背景是什么。当其他开发人员可以在不看模块代码的情况下使用您的项目时，您的文档就完成了，这意味着您可以将模块的文档化接口与内部实现分开，因此只要接口保持不变，您就可以自由更改代码在模块内部。安装此项目需要安装node和npm，如下所示：$npminstall--globalstandard-readme-specGenerator要使用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)maintainer你可以直接@项目相关的maintainer，这样其他人也可以很方便的联系到他在license的最后，你需要声明项目的开源协议。不同的开源协议有不同的限制。您需要查看相关条款，选择最适合您项目的开源协议。
