为了让您轻松上手 GitLab,这里列出了一些推荐的下一步操作。
已经是专家了?直接编辑这个 README.md 并让它成为您自己的。想简单点?使用底部的模板!
cd existing_repo
git remote add origin https://gitlab.com/ceald1/evilwinrm-ng.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 中列出它们。
说明您是否接受贡献以及接受贡献的要求是什么。
对于想要对您的项目进行更改的人,提供一些关于如何开始的文档会很有帮助。也许有他们应该运行的脚本或需要设置的环境变量。明确说明这些步骤。这些说明也可能对您未来的自己有用。
您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保高代码质量,并降低更改意外破坏某些内容的可能性。如果运行测试需要外部设置(例如启动 Selenium 服务器以在浏览器中进行测试),那么提供运行测试的说明尤其有用。
向为项目做出贡献的人表示感谢。
对于开源项目,说明其许可方式。
如果您对项目已经没有精力或时间,请在 README 顶部添加一条说明,说明开发已经放缓或完全停止。有人可能会选择分叉您的项目或自愿作为维护者或所有者介入,使您的项目得以继续。您也可以明确请求维护者。