为了使你更容易开始使用 GitLab，这里列出了一些推荐的下一步操作。
已经是专家？只需编辑此 README.md 并使其成为你自己的。想要更简单？使用底部的模板！
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/cryptohackapp.git
git branch -M main
git push -uf origin main
使用 GitLab 内置的持续集成。
当你准备好将此 README 变成你自己的时，只需编辑此文件并使用下面的便捷模板（或随意以你想要的任何方式构建它——这只是一个起点！）。感谢 makeareadme.com 提供此模板。
每个项目都是不同的，所以请考虑这些部分中哪些适用于你的项目。模板中使用的部分是对大多数开源项目的建议。还要记住，虽然 README 可能过长且详细，但过长总比过短好。如果你认为你的 README 太长，可以考虑使用其他形式的文档，而不是删减信息。
为你的项目选择一个自解释的名称。
让人们知道你的项目具体能做什么。提供上下文，并添加访问者可能不熟悉的任何参考的链接。这里还可以添加功能列表或背景小节。如果你的项目有替代方案，这是列出区分因素的好地方。
在一些 README 中，你可能会看到传达元数据的小图像，例如项目的所有测试是否通过。你可以使用 Shields 为你的 README 添加一些徽章。许多服务也有添加徽章的说明。
根据你正在制作的内容，包含截图甚至视频可能是个好主意（你经常看到的是 GIF 而不是实际视频）。像 ttygif 这样的工具有帮助，但可以查看 Asciinema 以获取更复杂的方法。
在特定生态系统中，可能有常见的安装方式，例如使用 Yarn、NuGet 或 Homebrew。但是，考虑到阅读你的 README 的人可能是新手，需要更多指导。列出具体步骤有助于消除歧义，让人们尽快开始使用你的项目。如果它仅在特定上下文中运行，例如特定的编程语言版本或操作系统，或者有需要手动安装的依赖关系，也请添加要求小节。
大量使用示例，并尽可能展示预期输出。在 README 中内联展示你能演示的最小用法示例是有帮助的，同时提供到更复杂示例的链接（如果它们太长而不适合包含在 README 中）。
告诉人们他们可以去哪里寻求帮助。可以是问题跟踪器、聊天室、电子邮件地址等的任意组合。
如果你对未来的发布有想法，最好在 README 中列出它们。
说明你是否接受贡献以及接受贡献的要求。对于想要为你的项目做出更改的人来说，有一些关于如何入门的文档会很有帮助。可能有一个他们应该运行的脚本或一些他们需要设置的环境变量。明确这些步骤。这些说明可能对你未来的自己也有用。
你还可以记录用于 lint 代码或运行测试的命令。这些步骤有助于确保高代码质量，并降低更改意外破坏某些内容的可能性。如果测试需要外部设置（例如启动 Selenium 服务器以在浏览器中进行测试），提供运行测试的说明尤其有帮助。
向那些为项目做出贡献的人表示感谢。
对于开源项目，说明其许可证类型。
如果你对项目失去了精力或时间，请在 README 顶部添加说明，说明开发已放缓或完全停止。有人可能会选择 fork 你的项目或自愿成为维护者或所有者，使你的项目得以继续。你还可以明确请求维护者。