畅行 GitHub：怎么写一个超棒的 README 文档

图片地址：https://img.ithome.com/newsuploadfiles/2020/7/20200726132228_5398.jpg

如果你很着急、只是想要模板，可以直接跳到底部（但这样一点不酷），准备酷的人，迈出成为 README 大师的第一步吧！（绝对不是点击诱饵）假如你刚刚创建了很棒的项目，并在 GitHub 上共享了它。你认为现在你只需坐等世界告诉你这个项目有多酷。毕竟，在过去的一个月中，你为这个极具挑战性的项目付出了不懈的努力，对吗？好吧，让我们退后一步，从检查项目的开发人员或用户的角度来看。尽管你知道自己的项目有多酷，也知道它是如何解决一个（直到你出现之前）尚未解决的紧迫问题，但是看你项目的人想知道你构建了一个什么样的世界。如果没有人知道如何使用你的软件，那情况非常糟糕。如果人们不知道你的软件是做什么的，就不会使用它或为它做出贡献，并且很可能会在开源软件的海洋中找到更清晰明了的东西。这就是 README 文件的用处！好的 README 文档就像是项目的外观。这是一个人在你的项目中首先要看的东西，它提供了软件的简要介绍。美观实用的 README 文档