改进 Github README 文件的 10 个实用部分

大家好

今天我们将介绍 10 个重要部分的列表，您可以将它们添加到您的 GitHub 项目中以改进您的 README 文件。

那么让我们开始吧...

第 1 部分：添加标题、描述和社交图片（可选）

Github 项目的标题和描述可以为用户提供项目的基本信息。此外，我们可以使用Socialify
服务 创建项目信息图，以提升项目展示效果。 例如：

Socialify可生成可在 Github README 中使用的精美项目图像，帮助您向全世界展示您的项目

第 2 部分：添加 shields io 徽章

Shields.io是一项创建清晰易读的 SVG 格式徽章的服务，可以轻松添加到 GitHub readme 文件或任何其他网页中。
这有助于以简洁的方式提供项目信息：

第三部分：项目演示

项目演示 URL 可帮助查看者轻松查看实际项目。我们还可以在面试过程中使用此功能快速向潜在面试官展示项目预览。

示例：

第 4 部分：项目截图

项目截图可以帮助用户在打开演示链接之前就了解产品。对于前端/全栈项目来说，这部分必不可少。

例如：

第 5 部分：功能

功能部分可用于列出最终用户在使用我们项目时将获得的所有优势，以及一些可供开发人员面试的技术优势。

例如：

第 6 节：安装步骤

如果有人想将我们的项目用于自己的软件开发目的，那么安装说明可以帮助他们正确设置项目。

例如：

第七部分：贡献指南（可选）

如果有人想通过拉取请求或功能建议为我们的项目做出贡献，他们首先需要阅读项目中列出的贡献指南。

例如：

第 8 部分：使用的技术（可选）

在本节中，我们可以列出构建项目时使用的技术或模块，以帮助其他人更好地理解创建组件。

例如：

第 9 部分：许可证信息（可选）

我们可以在此提供项目中使用的许可证信息，以便其他人了解使用指南。

例如：

第 10 部分：输入支持信息（可选）

我们可以在这里添加链接，邀请人们为项目点赞或通过捐赠来支持我们的工作。
例如：

您可以在此处查看包含所有这些部分的示例 repo：- Stories Feed Github

另外，我最近创建了一个工具，您可以使用基于表单的输入轻松地将此部分添加到您的 Github README 文件中：-

项目演示：- README Gen
Github 源代码：- README Gen Github

希望本文对大家有所帮助。以后我会持续关注更多类似的文章。