diff --git a/README.md b/README.md index 830cff2..b379b0f 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,9 @@ There are several ways to use it. - [Use Github Actions](#4-Use-Github-Actions) - [Use Github Actions with secrets](#5-Use-Github-Actions-with-secrets) - [Build in Visual Studio](#6-Build-in-Visual-Studio) -- [Use GUI](#7-Use-GUI) +- [Build in Github Actions](#7-Build-in-Github-Actions) - [Build with CMake](#8-Build-with-CMake) +- [Use GUI for Windows](#9-Use-GUI-for-Windows) ### 3.1 Encoding @@ -75,7 +76,7 @@ You can also compress `rarreg.key` into `rarkey.rar` and double-click it to run The new workflow can easily help you generate a license, you just need to follow these steps. -> Your `Username` and `License Name` will appear in the actions log, if you don't want to give out this information, see [5. Using Github Actions with secrets](#5-Use-Github-Actions-with-secrets). +> Your `` and `` will appear in the Actions log, if you don't want to give out this information, see [5. Using Github Actions with secrets](#5-Use-Github-Actions-with-secrets). ### 4.1 Fork @@ -193,7 +194,7 @@ Extract `rarreg_file.zip` to get `rarreg.7z`, unzip it with the password to get
Click to expand -If you don't want to compile it yourself, you can also go to the [release](https://github.com/bitcookies/winrar-keygen/releases/) page to get `winrar-keygen.exe`. +If you don't want to compile it yourself, you can compile it using [Actions](#7-Build-in-Github-Actions) or visit the [Release](https://github.com/bitcookies/winrar-keygen/releases/) to download the corresponding version. ### 6.1 Prerequisites @@ -311,18 +312,22 @@ Generate an ASCII-encoded license and output it only to the console.
-## 7. Use GUI +## 7. Build in Github Actions
Click to expand -If you are using Windows 10 or 11, you can use the GUI application, which is built using .NET 8 WPF and Fluent Design (WPF UI) and supports both `x64` and `ARM 64` architectures. +In Actions, you can build applications for six architectures: Linux x64, Linux ARM64, macOS ARM64, Windows x64, Windows Win32, and Windows ARM64. -You can obtain the project from the [gui](https://github.com/bitcookies/winrar-keygen/tree/gui) branch and build the GUI application yourself. For more detailed information, please refer to the [README](https://github.com/bitcookies/winrar-keygen/blob/gui/README.md) in that branch. +Click the **Fork** button in the upper-right corner of the project to fork the code to your GitHub. Then locate the forked repository, go to the Actions page, and run "Build All Platforms" (build.yml). -![GUI](assets/gui-light.png#gh-light-mode-only) +> Building on Windows takes about 20 minutes; we recommend building locally for faster results. -![GUI](assets/gui-dark.png#gh-dark-mode-only) +![Build](assets/build-workflow-light.png#gh-light-mode-only) + +![Build](assets/build-workflow-dark.png#gh-dark-mode-only) + +Once the workflow has run successfully, you can download it from Artifacts.
@@ -331,7 +336,7 @@ You can obtain the project from the [gui](https://github.com/bitcookies/winrar-k
Click to expand -For Linux or macOS users, you can use `build.yml` on the Actions page to build automatically, or you can compile it manually. +For Linux or macOS users, you can [build in Github Actions](#7-Build-in-Github-Actions), but you can also compile it yourself. ### 8.1 Linux (Ubuntu/Debian) @@ -368,9 +373,25 @@ The output is always `build/winrar-keygen`, and the version number is controlled
-## 9. Common Errors +## 9. Use GUI for Windows -### 9.1 Keygen Errors +
+Click to expand + +If you are using Windows 10 or 11, you can use the GUI application, which is built using .NET 8 WPF and Fluent Design (WPF UI) and supports both `x64` and `ARM 64` architectures. + +You can obtain the project from the [gui](https://github.com/bitcookies/winrar-keygen/tree/gui) branch and build the GUI application yourself. For more detailed information, please refer to the [README](https://github.com/bitcookies/winrar-keygen/blob/gui/README.md) in that branch. + +![GUI](assets/gui-light.png#gh-light-mode-only) + +![GUI](assets/gui-dark.png#gh-dark-mode-only) + +
+ + +## 10. Common Errors + +### 10.1 Keygen Errors Starting with version `ver4`, Keygen has added some common error messages. Please make corrections based on the output. @@ -380,22 +401,22 @@ Starting with version `ver4`, Keygen has added some common error messages. Pleas ./winrar-keygen.exe -h ``` -### 9.2 Github Actions Errors +### 10.2 Github Actions Errors If you encounter an error while using `ascii` encoding, it is because you are using non-ASCII characters. If you encounter an error while using `ansi` encoding, it is because the character encoding is not supported by the current Windows system. The system platform for GitHub Actions is `windows-2022-english` (ANSI code page 1252), and any non-ASCII characters will cause the process to fail. -## 10. Contributing +## 11. Contributing -### 10.1 Suggestion +### 11.1 Suggestion If you encounter any issues or have suggestions, feel free to open an issue on the [Issues](https://github.com/bitcookies/winrar-keygen/issues) page or submit a pull request. We and the community will be happy to help. -### 10.2 Thanks +### 11.2 Thanks Thanks to all contributors to this project, and to the community members who help answer questions in the [Issues](https://github.com/bitcookies/winrar-keygen/issues). -## 11. License +## 12. License The code is available under the [MIT license](https://github.com/bitcookies/winrar-keygen/blob/master/LICENSE) diff --git a/README.zh-CN.md b/README.zh-CN.md index d6eac06..7061a74 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -35,8 +35,9 @@ WinRAR 不是免费软件。如果你想使用它，你应当向 [**RARLAB**](ht + [使用 Github Actions](#4-使用-Github-Actions) + [使用 Github Actions with secrets](#5-使用-Github-Actions-with-secrets) + [通过 Visual Studio 编译使用](#6-通过-Visual-Studio-编译使用) -+ [使用 GUI](#7-使用 GUI) ++ [通过 Github Action 编译使用](#7-通过-Github-Actions-编译使用) + [通过 Cmake 编译使用](#8-通过-Cmake-编译使用) ++ [使用 Windows GUI](#9-使用-Windows-GUI) ### 3.1 编码说明 @@ -75,7 +76,7 @@ WinRAR license 有 `rarreg.key` 和 `rarkey.rar` 两种类型，它们仅在导 新的 workflow 能很方便的帮助你生成 license，你只需跟随以下步骤即可： -> 你的 `Username` 和 `License Name` 会出现在 actions 的日志中，如果你不想泄露这些信息，请参考 [5. 使用 Github Actions with secrets](#5-使用-Github-Actions-with-secrets)。 +> 你的 `` 和 `` 会出现在 Actions 的日志中，如果你不想泄露这些信息，请参考 [5. 使用 Github Actions with secrets](#5-使用-Github-Actions-with-secrets)。 ### 4.1 Fork @@ -193,7 +194,7 @@ WinRAR license 有 `rarreg.key` 和 `rarkey.rar` 两种类型，它们仅在导
点击展开 -如果你不想自行编译，也可以到 [Release](https://github.com/bitcookies/winrar-keygen/releases/) 页面获取对应版本的 `winrar-keygen.exe`。 +如果你不想自行编译，可以到在 [Actions](#7-通过-Github-Actions-编译使用) 中编译，也可以到 [Release](https://github.com/bitcookies/winrar-keygen/releases/) 页面获取对应版本的构建程序。 ### 6.1 前提条件 @@ -309,18 +310,22 @@ dd4ab952600ba16a99236d910bfa995d5f60651ec451f462511507
-## 7. 使用 GUI +## 7. 通过 Github Actions 编译使用
-Click to expand +点击展开 -如果你正在使用 Windows 10 / 11，你可以使用 GUI 程序，它基于 .NET 8 WPF 和 Fluent Design (WPF UI) 构建，提供 `x64` 和 `ARM 64` 两种架构支持。 +你可以在 Actions 中构建 Linux x64、Linux ARM64、macOS ARM64、Windows x64、Windows Win32 和 Windows ARM64 六种架构的应用程序。 -你可以在 [gui](https://github.com/bitcookies/winrar-keygen/tree/gui) 分支中获取项目，并自行构建 GUI 程序。更详细的信息请查看分支 [README](https://github.com/bitcookies/winrar-keygen/blob/gui/README.zh-CN.md)。 +点击该项目右上角的 **Fork** 按钮，fork 一份代码到你的 Github。然后找到你 fork 的仓库，进入 Actions 页面并手动执行 **Build All Platforms (build.yml)**。 -![GUI](assets/gui-light.png#gh-light-mode-only) +> Windows 的构建耗时在 20 分钟左右，建议本地构建速度更快。 -![GUI](assets/gui-dark.png#gh-dark-mode-only) +![Build](assets/build-workflow-light.png#gh-light-mode-only) + +![Build](assets/build-workflow-dark.png#gh-dark-mode-only) + +运行成功之后，可在 Artifacts 下载。
@@ -329,7 +334,7 @@ dd4ab952600ba16a99236d910bfa995d5f60651ec451f462511507
Click to expand -对于 Linux 或 macOS 用户，你可以在 Actions 页面用 `build.yml` 自动构建，也可以自行编译。 +对于 Linux 或 macOS 用户，你可以[通过 Github Actions 编译使用](#7-通过-Github-Actions-编译使用)，但也可以自行编译。 ### 8.1 Linux (Ubuntu/Debian) @@ -362,13 +367,29 @@ cmake --build . --config Release ./winrar-keygen --help ``` -产物都是 `build/winrar-keygen`，版本号由 `CMakeLists.txt` 中的 `APP_VERSION` 控制。 +文件生成在 `build/winrar-keygen`，版本号由 `CMakeLists.txt` 中的 `APP_VERSION` 控制。
-## 9. 常见错误 +## 9. 使用 Windows GUI -### 9.1 Keygen 错误 +
+Click to expand + +如果你正在使用 Windows 10 / 11，你可以使用 GUI 程序，它基于 .NET 8 WPF 和 Fluent Design (WPF UI) 构建，提供 `x64` 和 `ARM 64` 两种架构支持。 + +你可以在 [gui](https://github.com/bitcookies/winrar-keygen/tree/gui) 分支中获取项目，并自行构建 GUI 程序。更详细的信息请查看分支 [README](https://github.com/bitcookies/winrar-keygen/blob/gui/README.zh-CN.md)。 + +![GUI](assets/gui-light.png#gh-light-mode-only) + +![GUI](assets/gui-dark.png#gh-dark-mode-only) + +
+ + +## 10. 常见错误 + +### 10.1 Keygen 错误 从 `ver4` 版本开始，Keygen 增加了一些常见的 Error 提示信息，请根据输出信息来进行修正。 @@ -378,13 +399,13 @@ cmake --build . --config Release ./winrar-keygen.exe -h ``` -### 9.2 Github Actions 错误 +### 10.2 Github Actions 错误 如果你使用 `ascii` 编码时发生了错误，原因是你使用了非 ASCII 字符。 如果你 `ansi` 编码时发生了错误，原因是因为字符编码不受当前 Windows 系统支持。GitHub Actions 的系统平台是 `windows-2022-english` （ANSI code page 1252），包含非 ASCII 字符都会失败。 -### 9.3 关于简体中文版 +### 10.3 关于简体中文版 在 [**RARLAB**](https://www.rarlab.com/) 下载的简体中文版 WinRAR 将会自带广告组件，即使使用了 `rarreg.key` 授权，广告组件依旧会出现。这是由于简体中文代理商的一些意见，RARLAB 已将简体中文安装包的公开链接更换成了带有广告的简体中文安装包。 @@ -431,16 +452,16 @@ https://www.rarlab.com/rar/winrar-x64-624sc.exe 请注意区分上述连接地址，更多方法可以查看 [Issues #14](https://github.com/bitcookies/winrar-keygen/issues/14) 和 [Issues #19](https://github.com/bitcookies/winrar-keygen/issues/19)。 -## 10. 贡献 +## 11. 贡献 -### 10.1 反馈和建议 +### 11.1 反馈和建议 如果您在使用过程中遇到问题或有任何建议，欢迎在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 页面反馈，或提交 Pull Request。我们以及社区中的开发者将乐于为您提供帮助。 -### 10.2 感谢 +### 11.2 感谢 感谢所有为本项目做出贡献的开发者，以及在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 中热心解答问题的社区成员。 -## 11. 许可 +## 12. 许可 使用 [MIT License](https://github.com/bitcookies/winrar-keygen/blob/master/LICENSE) diff --git a/assets/build-workflow-dark.png b/assets/build-workflow-dark.png new file mode 100644 index 0000000..dbf4c69 Binary files /dev/null and b/assets/build-workflow-dark.png differ diff --git a/assets/build-workflow-light.png b/assets/build-workflow-light.png new file mode 100644 index 0000000..33e5bf3 Binary files /dev/null and b/assets/build-workflow-light.png differ