README

用于与KWALL主主题一起使用的子主题

入门指南

为了使您能够轻松地在GitLab中开始使用，这里有一份推荐的下一步操作列表。

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

添加您的文件

[ ] [创建](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) 或上传文件
[ ] [使用命令行添加文件](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) 或使用以下命令推送现有的Git仓库

cd existing_repo
git remote add origin https://gitlab.com/kwall/kwall-subtheme.git
git branch -M main
git push -uf origin main

与您的工具集成

[ ] [设置项目集成](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/integrations/)

与您的团队协作

[ ] [邀请团队成员和协作者](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/members/)
[ ] [创建新的合并请求](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
[ ] [自动关闭合并请求中的问题](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
[ ] [在管道成功时自动合并](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

测试和部署

使用GitLab内建的持续集成。

[ ] [开始使用GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/ci/quick_start/index.html)
[ ] [使用静态应用程序安全测试(SAST)分析您的代码以查找已知漏洞](https://gitlab.com/-/experiment/new_project_readme_content:16f5b25b2542223b35b67eeb12e0bd3a?https://docs.gitlab.com/ee/user/application_security/sast/)

编辑此README

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

良好的README建议

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

名称

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

描述

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

徽章

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

视觉元素

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

安装

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

用法

大量使用示例，并在可能的情况下展示预期的输出。如果它们太长而无法合理包含在README中，提供更多复杂示例的链接是有帮助的。

支持

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

路线图

如果您对未来发布有想法，将其列入README是一个好主意。

贡献

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

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

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

作者和致谢

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

许可

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

项目状态

如果你的项目耗尽了能量或时间，请在README文件顶部添加一个说明，表示开发速度已经减慢或完全停止。有人可能会选择分叉你的项目或志愿担任维护者或所有者，使你的项目能够继续进行。你还可以明确请求维护者。

kwall / kwall-subtheme

维护者

详细信息