21.如何编写 README？

README.md 文件，每个项目的开始。

当您从事开源项目或与团队合作时，创建一个好的 README 始终是一个挑战。我们总是有很多关于我们可以做什么、添加、删除……的问题。

我应该添加此信息吗？

是不是太多了？

我应该添加架构吗？

因此，为了帮助您在可以做什么、应该做什么以及如何做方面有一个良好的开端，这里是创建一个 README 项目。

正如我们谈论的如何编写变更日志？，本文档将为您提供创建高效自述文件的所有指南。此外，为了帮助您创建自述文件，还有大量非常酷的工具可供使用，例如

ReadMe.so：使用在线编辑器创建您的自述文件

Git badges : 将一些重要信息显示为徽章

Github Stats：显示有关您的 github 统计信息的一些信息

… 等等！

您可以在线查看，有很多工具，一些 git 项目列出了它们：

https://github.com/dhyeythumar/awesome-readme-tools
https://github.com/matiasingers/awesome-readme
现在您拥有创建高效 README 的所有工具！🚀

如果您需要更多灵感，请不要犹豫，查看其他项目的 README 文件或查看一些帖子。网上有很多帖子都在谈论很酷的 README 设计。

希望对您有所帮助！🍺