README

入门指南

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

已经是专家了吗？只需编辑此 README.md 并使其成为您自己的。想让它变得简单？使用下面的模板！

添加您的文件

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

cd existing_repo
git remote add origin https://gitlab.qwirl.de/qwirl/3d-manufaktur/contao-host.git
git branch -M main
git push -uf origin main

与您的工具集成

设置项目集成

与您的团队协作

测试和部署

使用 GitLab 内置的持续集成。

编辑此 README

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

优秀 README 的建议

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

名称

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

描述

让人们知道您的项目具体能做什么。提供上下文，并添加任何可能不熟悉的参考链接。也可以在此处添加功能列表或背景子部分。如果您的项目有替代品，这是列出不同点的良好位置。

徽章

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

视觉元素

根据您所制作的，包含屏幕截图甚至视频可能是一个好主意（您通常会看到 GIF 而不是实际视频）。工具如 ttygif 可能会很有帮助，但请检查 Asciinema 以获取更复杂的方法。

安装

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

使用方法

自由使用示例，并在可能的情况下显示预期的输出。在README中提供尽可能小的使用示例，同时提供指向更复杂示例的链接，如果它们太长而无法合理包含在内。

支持

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

路线图

如果您对未来版本有想法，请在README中列出它们。

贡献

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

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

您还可以记录用于检查代码或运行测试的命令。这些步骤有助于确保代码质量高，并减少无意中破坏东西的可能性。如果有外部设置要求运行测试，例如启动Selenium服务器进行浏览器测试，那么运行测试的说明特别有用。

作者和致谢

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

许可证

对于开源项目，说明其许可方式。

项目状态

如果您已经耗尽了为项目提供能量的精力或时间，请在README顶部添加一条说明，说明开发已放缓或已完全停止。有人可能会选择分支您的项目，或者志愿者担任维护者或所有者，使项目继续进行。您还可以明确提出对维护者的请求。

erikwegner / oidcproxy

维护者

详细信息