Readme规范学习

上篇学习了git的规范 然后在创立项目的时候 发现其实readme也比较重要 我在以前都忽略了readme的存在
于是系统学习学习
参考文章一个开源项目的readme文档应该包含哪些信息才算是一份合格的文档？ - 知乎 (zhihu.com)

必备的信息

项目背景（Background）

介绍为什么要做这个项目 背景和动机是什么

安装和使用(Install & Usage)

• 如何安装
• 如何使用

[Badge]

• 是否有类似项目 可以列出来

主要项目负责人 (Maintainers)

• 将其他开发者@出来

参加贡献的方式(Contributing)

• 写明如何想要进入我们的项目

开源协议(License)

• 也就是你的项目采用的开源协议