diff --git a/README.md b/README.md index c84d6cb..583db7c 100644 --- a/README.md +++ b/README.md @@ -72,13 +72,13 @@ You can modify the values corresponding to `text1` and `text2`: } ``` -It is important to note that `test1` and `test2` are **ANSI-encoded string, without null-terminator.** +It is important to note that `test1` and `test2` are **ANSI-encoded string, without space character.** Once you have finished making changes, click the **Commit changes** button and Github Actions will start automatically. If Github Actions does not start automatically, you will need to click on the Actions page to **allow this workflows to run**, then modify and commit `keygen/info.json` again. -### 3.3 Download key +### 3.3 Download Key Go to the Actions page to see the status of the program. @@ -88,9 +88,9 @@ Green means it ran successfully, yellow means it is running, red means it failed ![step-4](assets/actions-step-4.png) -After decompression, you will get `rarreg.key`, just drag and drop it into WinRAR. +After extract `rarreg_file.zip`, you will get `rarreg.key`, just drag and drop it into WinRAR. -If you get an invalid key, check that the `test1` and `test2` parameters are **ANSI encoded without spaces.** +If you get an invalid key, please check [the specific solution](#5. Invalid Key). ## 4. Build in Visual Studio @@ -102,7 +102,7 @@ If you don't want to compile it yourself, you can also go to the [release](https 1. Please make sure that you have **Visual Studio 2022**. Because this is a VS2022 project. If you are still using Visual Studio 2019, you can find projects for VS2019 in the [vs2019](https://github.com/bitcookies/winrar-keygen/tree/vs2019) branch, but this branch will no longer be maintained. -2. Please make sure you have installed `vcpkg` and the following libraries: +2. Please make sure you have installed `vcpkg` and the following libraries: * `mpir:x86-windows-static` * `mpir:x64-windows-static` @@ -154,7 +154,7 @@ Example: ![Terminal](assets/terminal.png) -Now you can see the newly generated file. +Now you can see the newly generated file: ```console RAR registration data @@ -170,7 +170,7 @@ de3cdc56b311475b484e80b48157a0c3af60ca4f7f9c75d49bc50d 5eede7ed46566b10bf033daa6384062b259194b1acbd1443042646 ``` -Save the generated information as `rarreg.key`. +Save the generated information in **ANSI encoding format** as `rarreg.key`. ## 5. Invalid Key @@ -178,41 +178,53 @@ Why is my `rarreg.key` invalid? ### 5.1 ANSI Encoded -`test1` and `test2` are **ANSI-encoded string, without null-terminator.** +`test1` and `test2` are **ANSI-encoded string, without space character** [Issues #5](https://github.com/bitcookies/winrar-keygen/issues/5). ```console winrar-keygen.exe ``` -### 5.2 Terminal Encode +You can refer to: [Generation of "rarreg.key"](https://github.com/bitcookies/winrar-keygen/blob/master/README.HOW_DOES_IT_WORK.md#7-generation-of-rarregkey) -[Issues #5](https://github.com/bitcookies/winrar-keygen/issues/5) Be sure to use ANSI encoding, without null-terminator. +### 5.2 TXT Encoding -You can refer to the Microsoft documentation: [Generation of "rarreg.key"](https://github.com/bitcookies/winrar-keygen/blob/master/README.HOW_DOES_IT_WORK.md#7-generation-of-rarregkey) +If you use the following command: -Thanks [@Sonic-The-Hedgehog-LNK1123](https://github.com/Sonic-The-Hedgehog-LNK1123) +```console +winrar-keygen.exe "Github" "Github.com" > rarreg.key +``` -## 6. Encounter problems? +In the newer Windows 10, PowerShell will export in **UTF16-LE** format by default, which will cause the error. -### 6.1 Feedback +Please use the following command: + +```console +winrar-keygen.exe "Github" "Github.com" > rarreg.key | out-file -encoding ascii rarreg.key +``` + +### 5.3 Location of Key + +If you are unable to drag, you can try to put the `rarreg.key` in the following directory. + +```console +C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key +``` + +## 6. Feedback If you encounter some problems, you can report on the [Issues](https://github.com/bitcookies/winrar-keygen/issues) page. There will be many enthusiastic developers or Github users to help you. -### 6.2 Security - -[Issues #1](https://github.com/bitcookies/winrar-keygen/issues/1) Some Anti-Virus Software may falsely report. If you do not trust this binary executable file, your only option is to compile the code yourself. - -### 6.3 Download - -[Issues #4](https://github.com/bitcookies/winrar-keygen/issues/4) IDM and other download tools may have problems, please use a browser (e.g. chrome, edge) to download. - ## 7. Contributing -This project welcomes contributions and suggestions. You can make suggestions in [Issues](https://github.com/bitcookies/winrar-keygen/issues), or submit a pull request :-) +### 7.1 Suggestion + +This project welcomes contributions and suggestions. You can make suggestions in [Issues](https://github.com/bitcookies/winrar-keygen/issues), or submit a pull request 😄 + +### 7.2 Thanks Thank you very much to some enthusiastic developers for helping answer some questions in [Issues](https://github.com/bitcookies/winrar-keygen/issues). -Thanks [@Sonic-The-Hedgehog-LNK1123](https://github.com/Sonic-The-Hedgehog-LNK1123) +🏆 Special Thanks [@Sonic-The-Hedgehog-LNK1123](https://github.com/Sonic-The-Hedgehog-LNK1123) ## 8. License diff --git a/README.zh-CN.md b/README.zh-CN.md index e61c19b..3c92e76 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -88,15 +88,15 @@ Github Action 是微软收购 Github 之后推出的 CI/CD 工具,通过以下 ![step-4](assets/actions-step-4.png) -解压缩后会得到 `rarreg.key` ,拖动导入 WinRAR 即可。 +将 `rarreg_file.zip` 解压缩后会得到 `rarreg.key`,然后拖动导入 WinRAR 即可。 -如果你得到的是无效的 key,请检查 `test1` 和 `test2` 参数是否是**不含空格的 ANSI 编码。** +如果你得到的是 key 是无效的,请查看 [解决方法](#5. Invalid Key)。 ## 4. 通过 Visual Studio 编译使用 -我建议通过 Github Actions 的方法来使用,但是你仍然可以自己进行编译。 +我建议通过 Github Actions 的方法来使用,但是你仍然可以选择自行编译。 -如果你不想自己编译,也可以到 [Release](https://github.com/bitcookies/winrar-keygen/releases/) 页面获取对应版本的 `winrar-keygen.exe`。 +如果你不想自行编译,也可以到 [Release](https://github.com/bitcookies/winrar-keygen/releases/) 页面获取对应版本的 `winrar-keygen.exe`。 ### 4.1 前提条件 @@ -166,7 +166,7 @@ de3cdc56b311475b484e80b48157a0c3af60ca4f7f9c75d49bc50d 5eede7ed46566b10bf033daa6384062b259194b1acbd1443042646 ``` -将生成的信息以文本格式保存为 `rarreg.key`,拖动导入 WinRAR 即可。 +将生成的信息以 ANSI 编码的文本格式保存为 `rarreg.key`。 ## 5. 无效的Key @@ -174,45 +174,57 @@ de3cdc56b311475b484e80b48157a0c3af60ca4f7f9c75d49bc50d ### 5.1 ANSI编码 -`test1` 以及 `test2` 生成的许可文本,均是 **不含空格的 ANSI 编码。** +`test1` 以及 `test2` 生成的许可文本,均是 **不含空格的 ANSI 编码** [Issues #5](https://github.com/bitcookies/winrar-keygen/issues/5)。 ```console winrar-keygen.exe ``` -### 5.2 终端编码的问题 - -[Issues #5](https://github.com/bitcookies/winrar-keygen/issues/5) 请务必使用 ANSI 编码(不包含空格): - 具体可参考原理文档:[授权文件"rarreg.key"的生成](https://github.com/bitcookies/winrar-keygen/blob/master/README.HOW_DOES_IT_WORK.zh-CN.md#7-%E6%8E%88%E6%9D%83%E6%96%87%E4%BB%B6rarregkey%E7%9A%84%E7%94%9F%E6%88%90) -感谢 [@Sonic-The-Hedgehog-LNK1123](https://github.com/Sonic-The-Hedgehog-LNK1123) +### 5.2 TXT编码 -## 6. 遇到问题 +如果你使用了如下命令: -### 6.1 反馈 +```console +winrar-keygen.exe "Github" "Github.com" > rarreg.key +``` + +在较新的 Windows 10 系统中,PowerShell 将默认以 **UTF16-LE** 格式导出,这将会导致错误。 + +请使用如下命令: + +```console +winrar-keygen.exe "Github" "Github.com" > rarreg.key | out-file -encoding ascii rarreg.key +``` + +### 5.3 Key的位置 + +如果你无法执行拖动操作,你可以尝试把 `rarreg.key` 放在以下目录中: + +```console +C:\Users\yourname\AppData\Roaming\WinRAR\rarreg.key +``` + +### 5.4 关于简体中文版 + +在 [__RARLAB__](https://www.rarlab.com/) 下载的简体中文版 WinRAR 将会自带广告组件,即使使用了 `rarreg.key` 授权,广告组件依旧会出现。如果您介意广告,可以下载其他语言版。 + +## 6. 反馈 如果您遇到了一些问题,可在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 页面反馈,会有很多热心的开发者及 Github 用户帮助你。 -### 6.2 安全 - -[Issues #1](https://github.com/bitcookies/winrar-keygen/issues/1) 一些杀毒软件可能会误报,如果您不信任此二进制可执行文件,您唯一的选择就是自己编译代码。 - -### 6.3 下载 - -[Issues #4](https://github.com/bitcookies/winrar-keygen/issues/4) IDM等下载工具可能会有问题,请使用浏览器(例如 chrome、edge)下载。 - -### 6.4 关于简体中文版 - -在 [__RARLAB__](https://www.rarlab.com/) 下载的简体中文版 WinRAR 将会自带广告组件,即使使用了 `rarreg.key` 授权,广告组件依旧会出现。如果您介意广告,可以尝试下载其他语言版。 - ## 7. 贡献 -该项目欢迎贡献和建议,您可以在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 提出建议,或者进行提交拉取请求 :-) +### 7.1 建议 + +该项目欢迎贡献和建议,您可以在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 提出建议,或者进行提交拉取请求 😄 + +### 7.2 感谢 非常感谢一些热心的开发者,在 [Issues](https://github.com/bitcookies/winrar-keygen/issues) 帮助解答一些问题。 -感谢 [@Sonic-The-Hedgehog-LNK1123](https://github.com/Sonic-The-Hedgehog-LNK1123) +🏆 特别感谢 [@Sonic-The-Hedgehog-LNK1123](https://github.com/Sonic-The-Hedgehog-LNK1123) ## 8. 许可 diff --git a/assets/actions-step-4.png b/assets/actions-step-4.png index c84e5c9..873e8ea 100644 Binary files a/assets/actions-step-4.png and b/assets/actions-step-4.png differ