如何使您的存储库自述文件看起来不错！

存储库自述文件对我总是很满意。 它们都有不同的风格，包括图像，GIF，徽章，链接等。它们不仅可以看上去，而且可以传达有关该项目进行中的大量信息，并且可以吸引人们的注意力。 可悲的是，我们大多数人，至少在项目开始时，没有浪费时间使我们的回购自述文件大放异彩。 今天，我将向大家展示适合您的回购交易的简便程度，使其看起来比以往更加专业。

免责声明：**这 如果圣诞节和新年前夕之间的一周内上线，则发布。 因此，尽管我可以做一些需要更少时间的事情，但仍然很重要。 继续阅读以了解如何使您的仓库回升。

在..之前很伤心.. =（

您可以在屏幕快照中看到我的Marvels App博客文章存储库的外观。 没有真正的吸引力。 对我而言，这仅是在提醒人们机会不足。 分享有关我的项目和目标的更多信息的机会。

**如果您尚未查看marvel的应用博客文章系列，则可以在这里进行。 您会发现许多有趣的内容，内容涉及如何使用许多不同的pod和工具从头开始创建应用程序，从而使您的生活更轻松。

给我看看更好的.. !!

本自述文件中有几件事正在进行，因此让我介绍一下：

• 现在它具有徽章，在顶部显示相关信息
• 它具有锚点导航，允许读者跳至特定部分。
• 它有一个屏幕截图，显示了应用程序流程以及用户对项目的期望。
• 它有一个动机部分，回答一些问题，例如： 这是什么？ 我为什么要在乎呢？ 它与他人有何不同？ 这个存储库的目标是什么 ？
• 它具有发布链接，将链接带到页面。
• 它具有安装和测试部分，提供有关如何运行这些步骤的说明。
• 最后但并非最不重要的一个许可证部分，显示代码的可用性 。

这可以像您认为的那样广泛。 您可以使用一些您喜欢的开源项目作为自己存储库的灵感源。

*您可以在这里查看 github上的页面。

自述文件的资源..

在下面，您可以找到一些资源，这些资源可以在上面提到的仓库转换过程中提供帮助。 去看一下！ shields.io是一个了不起的工具。 它允许您粘贴存储库URL，并可以根据您的回购文件推荐徽章。

Shields.io：开源项目的质量元数据徽章
我们提供快速且可扩展的信息图像，作为GitHub，Travis CI，Jenkins，WordPress等的徽章。

Codecov和工作服可以将您的代码覆盖率百分比显示为自定义徽章。 太棒了!!

连续代码覆盖率
连续代码覆盖率。 托管覆盖率报告与GitHub，Bitbucket和GitLab高度集成。 浏览器… codecov.io 工作服
修改说明 coveralls.zendesk.com

最终韧带..

其余的内容很简单，您可以随意调整和更改README.md。 有几种工具可以帮助您在将更改发送到存储库之前在本地预览更改，这很棒。 这个chrome扩展程序就是这样做的。

这篇文章的想法只是开始讨论，您可以使用README.md做更多的事情。

与往常一样，任何想法，疑问或反馈都值得欢迎。 =）

附：如果您喜欢这篇文章，请在Twitter上分享，或在中级推荐，或两者都=）。 这确实有助于我吸引更多人。 非常感谢 ..