# 如何写好README

`README`常常是工程的第一个入口，经常不知道写些什么，如何介绍工程的内容。在网上找了资料，发现这是很多人遇到的问题，也有很多热心人士发表了自己的意见

主要参考[RichardLitt/standard-readme](https://github.com/RichardLitt/standard-readme)，里面提出了一整套`REAMDE`规范，包括编写规范、`linter`、生成器、徽章以及示例

另外[kylelobo/The-Documentation-Compendium](https://github.com/kylelobo/The-Documentation-Compendium#templates)和[如何写好Github中的readme？](https://www.zhihu.com/question/29100816)也给出了很多建议

最终实现：[如何编写好的README](https://blog.zhujian.life/posts/79f69ebe.html)