README

入门

为了帮助您轻松开始使用GitLab，以下是一些建议的下一步操作。

已经是专家了？只需编辑此README.md并将其据为己有。想让它更容易？使用下面的模板！

添加您的文件

创建或上传文件
使用命令行添加文件或使用以下命令推送现有的Git仓库：

cd existing_repo
git remote add origin https://gitlab.com/pju-org/in-house/microservices/mesh.git
git branch -M master
git push -uf origin master

与您的工具集成

设置项目集成

与您的团队协作

测试和部署

使用GitLab内建的持续集成。

编辑此README

当您准备好将此README据为己有时，只需编辑此文件并使用下面的便捷模板（或者您可以根据需要自行结构化 - 这只是一个起点！）。感谢makeareadme.com提供此模板。

关于好的README的建议

每个项目都不同，因此请考虑哪些部分适用于您的项目。模板中使用的部分是大多数开源项目的建议部分。同时请注意，虽然README可以太长和详细，但太长比太短好。如果您认为您的README太长，请考虑使用其他形式的文档，而不是删除信息。

名称

为您的项目选择一个具有自解释性的名称。

描述

让人们知道您的项目具体能做什么。提供背景信息并添加任何可能不熟悉的参考链接。也可以在此处添加功能列表或背景子部分。如果您的项目有替代品，这是一个列出不同因素的好地方。

徽章

在某些README中，您可能会看到传达元数据的小图像，例如项目是否所有测试都通过。您可以使用Shields在README中添加一些徽章。许多服务也有添加徽章的说明。

视觉元素

根据您正在制作的内容，包括截图甚至视频（您通常会发现GIF而不是实际视频）。像ttygif这样的工具可以帮助，但请查看Asciinema以获得更复杂的方法。

安装

在特定的生态系统中，可能存在一种常见的安装方法，例如使用Yarn、NuGet或Homebrew。然而，考虑到阅读您的README文件的人可能是新手，可能需要更多的指导。列出具体的步骤有助于消除歧义，并让人们尽可能快地使用您的项目。如果它只在特定的上下文中运行，如特定的编程语言版本、操作系统或需要手动安装的依赖项，请也添加一个需求子节。

使用方法

广泛地使用示例，并在可能的情况下展示预期的输出。如果示例太长，无法合理地包含在README中，提供链接到更复杂的示例也是很有帮助的。

支持

告诉人们他们可以去哪里寻求帮助。可以是任何组合的问题跟踪器、聊天室、电子邮件地址等。

路线图

如果您对未来发布有任何想法，将它们列在README中是一个好主意。

贡献

声明您是否接受贡献以及接受贡献的要求。

对于想要修改您的项目的人来说，有一份如何开始的文档是很有帮助的。也许有一个脚本他们应该运行，或者一些他们需要设置的环境变量。明确这些步骤。这些说明也可能对您的未来自我有帮助。

您还可以记录代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并减少更改意外破坏某些内容的风险。如果有外部设置要求运行测试，如启动Selenium服务器以在浏览器中进行测试，那么提供运行测试的说明尤其有帮助。

作者和致谢

向为项目做出贡献的人表示感谢。

许可协议

对于开源项目，说明它的许可协议。

项目状态

如果您对您的项目感到精疲力尽或时间不足，请在README的顶部注明开发已减缓或完全停止。有人可能会选择分支您的项目或自愿担任维护者或所有者，从而使您的项目继续进行。您还可以明确要求维护者。

webam / mesh

维护者

详细信息