README

入门指南

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

已经是专家了吗？只需编辑此README.md并使其成为您的专属。想要更简单？使用下方的模板！

添加您的文件

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

cd existing_repo
git remote add origin https://git.merkur-moebel.de/kuechenpate/magento2-module-brands.git
git branch -M master
git push -uf origin master

与您的工具集成

设置项目集成

与您的团队协作

测试和部署

使用GitLab内置的持续集成。

编辑此README

准备好将此README变成您的专属时，只需编辑此文件并使用下方方便的模板（或者您可以根据需要自由组织结构，这只是一个起点！）。感谢makeareadme.com提供此模板。

关于好的README的建议

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

名称

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

描述

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

徽章

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

视觉元素

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

安装

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

使用方法

广泛使用示例，并在可能的情况下展示预期的输出。提供尽可能小的使用示例非常有帮助，同时提供链接到更复杂的示例，如果它们太长而无法合理地包含在README中。

支持

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

路线图

如果您对未来发布的想法，将它们列在README中是一个好主意。

贡献

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

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

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

作者和致谢

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

许可证

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

项目状态

如果您已经耗尽了为项目提供能量的精力或时间，请在README的顶部注明开发已经放缓或完全停止。有人可能选择分叉您的项目或志愿成为维护者或所有者，使您的项目能够继续。您还可以明确请求维护者。

厨房伴侣 / 品牌

维护者

详细信息