normalize-hebrew-rs

入门指南

为了方便您在GitLab上开始使用，以下是一些推荐的下一步操作。

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

添加您的文件

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

cd existing_repo
git remote add origin https://gitlab.gwdg.de/qumran-digital/normalize-hebrew-rs.git
git branch -M main
git push -uf origin main

与您的工具集成

• 设置项目集成

与您的团队协作

• 邀请团队成员和协作者
• 创建一个新的合并请求
• 自动关闭合并请求中的问题
• 启用合并请求审批
• 当管道成功时自动合并

测试和部署

使用GitLab内置的持续集成。

• 开始使用GitLab CI/CD
• 使用静态应用程序安全测试(SAST)分析代码中的已知漏洞
• 使用自动部署将应用程序部署到Kubernetes、Amazon EC2或Amazon ECS
• 使用基于拉的部署以改进Kubernetes管理
• 设置受保护的环境

编辑此README

当您准备好使此README成为您自己的时，只需编辑此文件并使用下面的便捷模板（或者您可以随意组织它 - 这只是一个起点！）感谢makeareadme.com提供的模板。

良好README的建议

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

名称

为您的项目选择一个易于理解的名称。

描述

让人们了解您的项目具体能做什么。提供上下文，并添加链接以供不熟悉的访问者参考。在此处还可以添加功能列表或背景子节。如果您的项目有替代品，这也是列出不同之处的好地方。

徽章

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

视觉元素

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

安装

在特定的生态系统内，可能存在一种常见的安装方式，例如使用Yarn、NuGet或Homebrew。然而，考虑到阅读您的README的人可能是个新手，并且希望获得更多指导，列出具体步骤有助于消除歧义，并尽快让人们对您的项目产生兴趣。如果它仅在特定环境中运行（例如特定编程语言版本或操作系统）或需要手动安装依赖项，也可以添加一个要求子节。

用法

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

支持

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

路线图

如果您对未来发布有任何想法，请在README中列出它们。

贡献

说明您是否欢迎贡献以及接受贡献的要求。

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

您还可以记录用于代码检查或运行测试的命令。这些步骤有助于确保代码质量高，并降低无意中破坏某物的可能性。如果需要外部设置（例如在浏览器中测试时启动Selenium服务器）来运行测试，那么运行测试的说明尤其有用。

作者和致谢

感谢那些为项目做出贡献的人。

许可证

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

项目状态

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