diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1755e392f..c87b07154 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,8 @@ ## Welcome to Lenvo Legion Toolkit contributing guide! +### Other language versions of this contributing guide: +* [简体中文版开发者指南](CONTRIBUTING_zh-hans.md) + Thanks for investing your time in contributing to this project! Giving the growing popularity of LLT, here are a few rules to follow to ensure that your contribution goes smoothly.
diff --git a/CONTRIBUTING_zh-hans.md b/CONTRIBUTING_zh-hans.md new file mode 100644 index 000000000..302bf20fd --- /dev/null +++ b/CONTRIBUTING_zh-hans.md @@ -0,0 +1,59 @@ +## 欢迎来到拯救者工具箱开发者指南 + +首先感谢你花时间为此项目做出贡献！随着拯救者工具箱的热度越来越高，为了确保你的贡献能够被迅速采纳，你应该遵守一定的格式和规则。 + +
+ +_由于 Issues 总量的增加，不符合标准的 Issue 会在无预先警告的情况下被关闭或删除。屡次违反者将被本项目封禁。_ + +
+ +**1. 在报告 Issue 前请仔细阅读 README** + +绝大多数常见问题的解决方法和重要信息都已在 [README](https://github.com/BartoszCichecki/LenovoLegionToolkit/blob/master/README_zh-hans.md) 内阐明。请务必在报告 Issue 或发起讨论前通读其中的内容。 + +**2. 检查已被报告的 Issues** + +请检查项目仓库下的 [Issues](https://github.com/BartoszCichecki/LenovoLegionToolkit/issues?q=is%3Aissue) 和 [Discussions](https://github.com/BartoszCichecki/LenovoLegionToolkit/discussions?discussions_q=) 栏目。请不要报告重复的 Issue 或发起重复的讨论。即使你找到的 Issue 已经被关闭，你一样可以在那里留言。 + +**3. 使用英语** + +这会让所有人之间的交流都更加便利。 + +译者提示：若你无法流畅地使用英语表达，你可以在使用中文完成草稿后使用百度翻译或 [DeepL](https://www.deepl.com/zh/translator) 等翻译网站或软件将草稿翻译为英语后提交。 + +**4. 尊重项目目标** + +这不是一个万能的应用。项目的愿景很明确：为拯救者笔记本提供一个 Legion Zone（海外版则为 Vantage）的替代品。请勿要求支持其它类型或型号的设备。 + +**5. 在新建 Issue 前审查你的问题** + +请确保 Bug 确实是 LLT 的 Bug。这不是一个免费的系统故障排除论坛，如果你在使用被修改过的 Windows 版本或你的系统本身已经出现问题，请自行解决。 + +**6. 尽所能详细描述你的问题** + +详细的描述是解决问题的关键所在。请在新建 Issue 时填写表单内的所有项目并提供日志文件。只有提供良好的描述我们才能更快地解决问题。 + +**7. 为你的 Issue 或条论起一个好的标题** + +这样可以极大方便浏览 Issue 和讨论列表。“使用 LLT 时出现问题”并不是一个好的标题。 + +**8. 围绕主题** + +不要发表与主题无关或无意义的留言。 + +**9. 一个 Issue 一个问题** + +请不要在一个 Issue 内同时报告多个问题或请求添加多个功能。请为每一个问题、主题或想法新建一个单独的 Issue 或讨论，这会让后期跟进更加容易。 + +**10. 翻译** + +我们使用 [Crowdin](https://crowdin.com/project/llt) 作为软件翻译平台。如果你想为翻译做出贡献，请在那里申请访问项目的权限。 + +**11. Pull requests** + +我们欢迎你提交 PR（当然了）。除非你提交了一个非常简单易懂的 PR，请先创建一个 Issue 并描述你正在解决的问题。为一个会被拒绝的点子花时间并没有什么意义，因为这不符合本项目的愿景。同时请遵循现有的代码风格和项目组织。 + +
+ +再次感谢你花时间帮助 LLT 变得更好！ diff --git a/README_zh-hans.md b/README_zh-hans.md index bd24e3bd4..98bd7d363 100644 --- a/README_zh-hans.md +++ b/README_zh-hans.md @@ -5,6 +5,7 @@ [![Build](https://github.com/BartoszCichecki/LenovoLegionToolkit/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/BartoszCichecki/LenovoLegionToolkit/actions/workflows/build.yml) [![Crowdin](https://badges.crowdin.net/llt/localized.svg)](https://crowdin.com/project/llt) [![Join Discord](https://img.shields.io/discord/761178912230473768?label=Legion%20Series%20Discord)](https://discord.com/invite/legionseries) +Featured｜HelloGitHub --- @@ -18,11 +19,8 @@ **中文用户可加入[拯救者工具箱 QQ 频道](https://pd.qq.com/s/jj0737)，频道内推送正式版/测试版更新并附带国内镜像加速下载链接。** -如果你正在寻找一个 Lenovo Vantage 在 Linux 系统下的替代品，请查看 [LenovoLegionLinux](https://github.com/johnfanv2/LenovoLegionLinux) 项目。 - -    # 目录 @@ -65,12 +63,15 @@ scoop install extras/lenovolegiontoolkit ``` +> [!TIP] +> 如果你正在寻找一个 Lenovo Vantage 在 Linux 系统下的替代品，请查看 [LenovoLegionLinux](https://github.com/johnfanv2/LenovoLegionLinux) 项目。 #### 接下来的步骤 拯救者工具箱在后台运行时效果最好，所以去设置中启用_开机启动_和_关闭时最小化_。接下载就是在设置中禁用 Lenovo Vantage, Legion Zone 与 Lenovo Hotkeys，或者你也可以直接卸载他们。之后，拯救者工具箱将会在开机后自启并在后台一直保持运行，并接管 Lenovo Vantage, Legion Zone 与 Lenovo Hotkeys 的功能。 -另，如果你完全关闭拯救者工具箱，一些功能例如同步不同的性能模式（Fn + Q）与电源计划，键盘宏以及自动化功能将无法正常工作。这是因为 LLT **不运行任何后台服务**，也就意味着其无法在被完全关闭时响应指令或执行设置同步。 +> [!WARNING] +> 如果你完全关闭拯救者工具箱，一些功能例如同步不同的性能模式（Fn + Q）与电源计划，键盘宏以及自动化功能将无法正常工作。这是因为 LLT **不运行任何后台服务**，也就意味着其无法在被完全关闭时响应指令或执行设置同步。 另外，请查看下方的 [兼容性](#兼容性) 部分。 @@ -90,7 +91,8 @@ 3. 点击安装程序下的“X64”一栏下载安装程序； 4. 运行安装程序并按照指引进行安装。 -> 注意：如果你是使用 Scoop 安装了 LLT，.NET 8 依赖应该已经被自动安装。如果它没有被安装或 LLT 无法正常启动，可以使用 `scoop update` 以更新所有软件包并加上 `--force` 参数以强制重新安装 LLT。 +> [!NOTE] +> 如果你是使用 Scoop 安装了 LLT，.NET 8 依赖应该已经被自动安装。如果它没有被安装或 LLT 无法正常启动，可以使用 `scoop update` 以更新所有软件包并加上 `--force` 参数以强制重新安装 LLT。 在完成这些步骤后，你可以打开终端并输入： `dotnet --info`。在输出中寻找 "已安装的 .NET 运行时 "部分，你应该能看到类似的内容： @@ -123,6 +125,9 @@ 总的来说，建议在使用拯救者工具箱时禁用或卸载 Lenovo Vantage、Hotkeys 和 Legion Zone。当拯救者工具箱与其他联想应用程序一起工作时，可能会导致部分功能冲突或可能无法正常工作。 +> [!TIP] +> 一般来说最简单的解决方法就是使用拯救者工具箱内的禁用选项。 + ### 备注 拯救者工具箱目前不支持多用户安装，所以如果你的笔记本电脑上有多个用户，你可能会遇到兼容性问题，即使是没有管理员权限的账户。拯救者工具箱需要一个有管理员权限的账户，拯救者工具箱无法在普通账户上正常运行。 @@ -163,10 +168,14 @@ LLT 也支持其他像一级或三级白色键盘背光，Legion Logo 背光和 需要 Corsair iCue 的灯光控制不会被 LLT 支持。 -_**注意：** 目前已知 Riot Vanguard DRM（使用它的游戏有例如：瓦罗兰特） 会造成 RGB 和灯光控制功能出现问题。如果你在安装了它之后发现了 LLT 内 RGB 设置消失的错误，请卸载它或确保它并非开机自启项。_ +> [!IMPORTANT] +> 目前已知 Riot Vanguard DRM（使用它的游戏有例如：瓦罗兰特） 会造成 RGB 和灯光控制功能出现问题。如果你在安装了它之后发现了 LLT 内 RGB 设置消失的错误，请卸载它或确保它并非开机自启项。 ### 混合模式和显卡工作模式 +> [!NOTE] +> 请注意这些功能和英伟达 Advanced Optimus 动态显示切换不同，也不与其一同工作。 + 你有两种主要工作模式来控制你的独立显卡工作方式： 1. 启用混合模式 - 内置显示器会被连接到集成显卡，独立显卡只会在需要时工作以延长续航。 @@ -185,9 +194,8 @@ _**注意：** 目前已知 Riot Vanguard DRM（使用它的游戏有例如： 如果你还遇到问题，请尝试[命令行参数](#命令行参数)内的其他实验性显卡工作模式。 -**通过设备管理器禁用独立显卡并不会断开独立显卡连接，并同时会导致高耗电量！** - -请注意这些功能和英伟达 Advanced Optimus 动态显示切换不同，也不与其一同工作。 +> [!WARNING] +> 通过设备管理器禁用独立显卡并不会断开独立显卡连接，并同时会导致高耗电量！ ### 强制休眠英伟达显卡 @@ -200,7 +208,8 @@ _**注意：** 目前已知 Riot Vanguard DRM（使用它的游戏有例如： 当独显处于活动状态，并使用混合模式且没有外接显示器到独显上时，强制休眠显卡才会亮起。如果你将鼠标悬停在右侧的问号标志上，将会看到独显的状态与正在使用独显的进程。 -注意，强制休眠显卡可能会导致一些应用崩溃。 +> [!NOTE] +> 强制休眠显卡可能会导致一些应用崩溃。 ### 超频英伟达独立显卡 @@ -456,7 +465,10 @@ LLT 会自动在进程运行环境内添加一些可被访问的环境变量。 在 2.11.0 版本后，拯救者工具箱与 Lenovo Vantage 与 Legion Zone 的行为保持一致，将不再允许在没有插入适当电源适配器的情况下启用野兽与自定义模式。 -如果出于某种原因，你想在电池供电的情况下使用这些模式，你可以使用`--allow-all-power-modes-on-battery`参数来启用（参见[命令行参数](#命令行参数)）。请注意，当笔记本电脑没有连接到全功率的电源适配器时，功耗限制与其他设置在大多数设备上无法正常应用，同时可能会出现一些未知的问题。 +如果出于某种原因，你想在电池供电的情况下使用这些模式，你可以使用`--allow-all-power-modes-on-battery`参数来启用（参见[命令行参数](#命令行参数)）。 + +> [!WARNING] +> 当笔记本电脑没有连接到全功率的电源适配器时，功耗限制与其他设置在大多数设备上无法正常应用，同时可能会出现一些未知的问题。 #### 我可以在使用拯救者工具箱时使用其他RGB软件吗？ @@ -558,20 +570,14 @@ Windows 可能无法正确识别所有的游戏，但你可以在 Xbox Game Bar 我感谢你们提交的任何反馈！不要犹豫，直接提交 Issue。我们也欢迎提交 PR，但提交 PR 前务必查看 [CONTRIBUTING.md](CONTRIBUTING.md) 文件！ -（译者提示：由于 LLT 并非由国人发起的项目，主要开发者也大多来自欧美，为了整体交流环境的统一和协调，所有 Issue，PR 和 Commit Message **必须**使用英语书写，否则将被直接关闭并锁定，**没有例外**。此点也已在 [CONTRIBUTING.md](CONTRIBUTING.md) 中说明。若你无法流畅地使用英语表达，你可以在使用中文完成草稿后使用百度翻译或 [DeepL](https://www.deepl.com/zh/translator) 等翻译网站或软件将草稿翻译为英语后提交。） - -#### 翻译 - -我们已选择 Crowdin 为翻译平台。如果你想提交软件内文本翻译请访问 https://crowdin.com/project/llt 并申请权限。 - -对于此简体中文版 README 则可以直接在代码仓库里提交 PR 贡献翻译。 - -#### Bugs - -如果你发现了软件中的任何 Bug 和问题，请报告。如果你附上日志将会对我们发现问题的根本原因十分有帮助。 你可以在 `%LOCALAPPDATA%\LenovoLegionToolkit\log` 找到日志文件。提交 Issue 时记得附上最新的日志文件！ +> [!IMPORTANT] +> 译者提示：由于 LLT 并非由国人发起的项目，主要开发者也大多来自欧美，为了整体交流环境的统一和协调，所有 Issue，PR 和 Commit Message **必须**使用英语书写，否则将被直接关闭并锁定，**没有例外**。此点也已在 [CONTRIBUTING.md](CONTRIBUTING.md) 中说明。若你无法流畅地使用英语表达，你可以在使用中文完成草稿后使用百度翻译或 [DeepL](https://www.deepl.com/zh/translator) 等翻译网站或软件将草稿翻译为英语后提交。 #### 适配 +> [!IMPORTANT] +> 拯救者工具箱只目标适配联想拯救者（海内及海外版）、IdeaPad Gaming 和 LOQ 系列。请不要为除上述系列以外的设备提出兼容请求。 + 如果能适配更多设备就更好了！但要做到这点，我真的很需要你的帮助！ 如果你愿意在未适配的机型上试试这个软件，请在启动时点击弹窗的继续按钮，拯救者工具箱会自动打开日志记录，这样你就可以在提交 Issue 时提交了！