Skip to content

Commit 9fd45c3

Browse files
committed
📙 Optimization README
1 parent f514d1f commit 9fd45c3

16 files changed

+63
-675
lines changed

Diff for: README.md

+26-12
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</a>
1313
<img src="https://img.shields.io/badge/Visual%20Studio-2022-5D4298" />
1414
<a href="https://github.com/bitcookies/winrar-keygen/actions">
15-
<img src="https://github.com/bitcookies/winrar-keygen/actions/workflows/action.yml/badge.svg" />
15+
<img src="https://github.com/bitcookies/winrar-keygen/actions/workflows/action_secrets.yml/badge.svg" />
1616
</a>
1717
<a href="https://github.com/bitcookies/winrar-keygen/blob/master/LICENSE">
1818
<img alt="License" src="https://img.shields.io/github/license/bitcookies/winrar-keygen.svg" />
@@ -61,9 +61,17 @@ Use [Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secre
6161

6262
![Fork](assets/fork-dark.png#gh-dark-mode-only)
6363

64-
### 4.2 Creating Secrets
64+
### 4.2 Allow Fork repo to run Workflows
6565

66-
Open your forked repository, and go to **Settings > Secrets > Actions > New repository secret**.
66+
Go back to the repo you just forked and click **Actions** to allow Workflows to run in your forked repo.
67+
68+
![Workflow](assets/enable-workflows-light.png#gh-light-mode-only)
69+
70+
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
71+
72+
### 4.3 Creating Secrets
73+
74+
After allowing Workflows, go to **Settings > Secrets and variables > Actions > New repository secret**.
6775

6876
![Secrets](assets/secrets-light.png#gh-light-mode-only)
6977

@@ -81,7 +89,7 @@ Once created, you will see:
8189

8290
![Secrets Repo](assets/secrets-repo-dark.png#gh-dark-mode-only)
8391

84-
### 4.3 Run Workflow
92+
### 4.4 Run Workflow
8593

8694
Go to **Actions** and select **WinRAR Keygen Secrets** to run Workflow manually.
8795

@@ -95,6 +103,10 @@ After running successfully, open the corresponding task and select **rarreg_file
95103

96104
![Download](assets/file-download-dark.png#gh-dark-mode-only)
97105

106+
After extract `rarreg_file.zip`, you will get `rarreg.key`, just drag and drop it into WinRAR. You can also compress `rarreg.key` into `rarkey.rar` and double-click it to run it, and the license import will take place automatically.
107+
108+
If you get an invalid key, please check [the specific solution](#7-invalid-key).
109+
98110
</details>
99111

100112
## 5. Use Github Actions with Push
@@ -114,7 +126,15 @@ Using push for key generation is very simple and convenient, but when there are
114126

115127
If you've forked before and I've committed new code, but you don't know how to merge the new content into your repository, then you can delete the current fork and fork again.
116128

117-
### 5.2 Modify info.json
129+
### 5.2 Allow Fork repo to run Workflows
130+
131+
Go back to the repo you just forked and click **Actions** to allow Workflows to run in your forked repo.
132+
133+
![Workflow](assets/enable-workflows-light.png#gh-light-mode-only)
134+
135+
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
136+
137+
### 5.3 Edit info.json
118138

119139
Open your forked repository, and go to `keygen/info.json` and click on the edit button to edit the file.
120140

@@ -144,13 +164,7 @@ It is important to note that `test1` and `test2` are **ANSI-encoded string, spac
144164

145165
Once you have finished making changes, click the **Commit changes** button and Github Actions will start automatically.
146166

147-
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.
148-
149-
![Workflow](assets/enable-workflows-light.png#gh-light-mode-only)
150-
151-
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
152-
153-
### 5.3 Download Key
167+
### 5.4 Download Key
154168

155169
Go to **Actions** and select **WinRAR Keygen** to see the status of the program.
156170

Diff for: README.zh-CN.md

+37-23
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</a>
1313
<img src="https://img.shields.io/badge/Visual%20Studio-2022-5D4298" />
1414
<a href="https://github.com/bitcookies/winrar-keygen/actions">
15-
<img src="https://github.com/bitcookies/winrar-keygen/actions/workflows/action.yml/badge.svg" />
15+
<img src="https://github.com/bitcookies/winrar-keygen/actions/workflows/action_secrets.yml/badge.svg" />
1616
</a>
1717
<a href="https://github.com/bitcookies/winrar-keygen/blob/master/LICENSE">
1818
<img alt="License" src="https://img.shields.io/github/license/bitcookies/winrar-keygen.svg" />
@@ -25,13 +25,13 @@
2525

2626
## 1. WinRAR是什么?
2727

28-
WinRAR是一款用于管理压缩包文件的共享软件。其算法由作者尤金·罗谢尔研发,享有原创专利。
28+
WinRAR 是一款用于管理压缩包文件的共享软件。其算法由作者尤金·罗谢尔研发,享有原创专利。
2929

30-
它可以用来创建或浏览RAR、ZIP等众多格式的压缩包
30+
它可以用来创建或浏览 RAR、ZIP 等众多格式的压缩包
3131

32-
WinRAR不是免费软件。如果你想使用它,你应当向 [__RARLAB__](https://www.rarlab.com/) 付费,然后获得一个授权文件 `rarreg.key`
32+
WinRAR 不是免费软件。如果你想使用它,你应当向 [__RARLAB__](https://www.rarlab.com/) 付费,然后获得一个授权文件 `rarreg.key`
3333

34-
这份repo将会告诉你 `rarreg.key` 是如何生成的。
34+
这份 repo 将会告诉你 `rarreg.key` 是如何生成的。
3535

3636
## 2. "rarreg.key"是如何生成的?
3737

@@ -61,9 +61,17 @@ WinRAR不是免费软件。如果你想使用它,你应当向 [__RARLAB__](htt
6161

6262
![Fork](assets/fork-dark.png#gh-dark-mode-only)
6363

64-
### 4.2 创建 Secrets
64+
### 4.2 允许 Fork 代码运行 Workflows
6565

66-
打开你 fork 后的仓库,进入 **Settings > Secrets > Actions > New repository secret** 来创建:
66+
返回到你刚刚 fork 完成的 repo,然后点击 **Actions** 去允许 Workflows 在你的 fork repo 中运行:
67+
68+
![Workflow](assets/enable-workflows-light.png#gh-light-mode-only)
69+
70+
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
71+
72+
### 4.3 创建 Secrets
73+
74+
允许 Workflows 后,进入 **Settings > Secrets and variables > Actions > New repository secret** 来创建 Secrets:
6775

6876
![Secrets](assets/secrets-light.png#gh-light-mode-only)
6977

@@ -81,9 +89,9 @@ WinRAR不是免费软件。如果你想使用它,你应当向 [__RARLAB__](htt
8189

8290
![Secrets Repo](assets/secrets-repo-dark.png#gh-dark-mode-only)
8391

84-
### 4.3 运行 Workflow
92+
### 4.4 运行 Workflow
8593

86-
进入 **Actions** 并选择 **WinRAR Keygen Secrets** 来手动执行 Workflow:
94+
进入 **Actions** 并选择 **WinRAR Keygen Secrets > Run workflow > Run workflow ** 来手动执行 Workflow:
8795

8896
![Run](assets/run-workflow-light.png#gh-light-mode-only)
8997

@@ -95,6 +103,10 @@ WinRAR不是免费软件。如果你想使用它,你应当向 [__RARLAB__](htt
95103

96104
![Download](assets/file-download-dark.png#gh-dark-mode-only)
97105

106+
`rarreg_file.zip` 解压缩后会得到 `rarreg.key`,然后拖动导入 WinRAR 即可。你也可以将 `rarreg.key` 压缩成 `rarkey.rar`,然后双击运行,授权导入将会自动进行。
107+
108+
如果你得到的是 key 是无效的,请查看 [解决方法](#7-无效的-Key)
109+
98110
</details>
99111

100112
## 5. 通过 Push 使用 Github Actions
@@ -114,9 +126,17 @@ WinRAR不是免费软件。如果你想使用它,你应当向 [__RARLAB__](htt
114126

115127
如果你之前 fork 过,然后我提交了新的代码,但是你不懂得如何合并新内容到你的仓库,那你也可以删掉当前 fork 的仓库,然后重新 fork 一次。
116128

117-
### 5.2 修改 info.json
129+
### 5.2 允许 Fork 代码运行 Workflows
130+
131+
返回到你刚刚 fork 完成的 repo,然后点击 Actions 去允许 Workflows 在你的 fork repo 中运行:
118132

119-
打开你 fork 后的仓库,进入 `keygen/info.json`,点击编辑按钮,对该文件进行编辑:
133+
![Workflow](assets/enable-workflows-light.png#gh-light-mode-only)
134+
135+
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
136+
137+
### 5.3 修改 info.json
138+
139+
允许 Workflows 后,进入 `keygen/info.json`,点击编辑按钮,对该文件进行编辑:
120140

121141
![Edit](assets/edit-json-light.png#gh-light-mode-only)
122142

@@ -144,13 +164,7 @@ WinRAR不是免费软件。如果你想使用它,你应当向 [__RARLAB__](htt
144164

145165
修改完成之后,点击 **Commit changes** 按钮,Github Actions 会自动开始执行。
146166

147-
如果 Github Actions 未自动开始,你需要先点击 Actions 页面 **允许此 workflows 运行**,然后再次修改并提交 `keygen/info.json`
148-
149-
![Workflow](assets/enable-workflows-light.png#gh-light-mode-only)
150-
151-
![Workflow](assets/enable-workflows-dark.png#gh-dark-mode-only)
152-
153-
### 5.3 下载文件
167+
### 5.4 下载文件
154168

155169
进入 **Actions** 并选择 **WinRAR Keygen** 页面查看程序运行状况:
156170

@@ -166,7 +180,7 @@ WinRAR不是免费软件。如果你想使用它,你应当向 [__RARLAB__](htt
166180

167181
`rarreg_file.zip` 解压缩后会得到 `rarreg.key`,然后拖动导入 WinRAR 即可。你也可以将 `rarreg.key` 压缩成 `rarkey.rar`,然后双击运行,授权导入将会自动进行。
168182

169-
如果你得到的是 key 是无效的,请查看 [解决方法](#7-无效的key)
183+
如果你得到的是 key 是无效的,请查看 [解决方法](#7-无效的-Key)
170184

171185
</details>
172186

@@ -251,11 +265,11 @@ de3cdc56b311475b484e80b48157a0c3af60ca4f7f9c75d49bc50d
251265

252266
</details>
253267

254-
## 7. 无效的Key
268+
## 7. 无效的 Key
255269

256270
为什么我生成的 `rarreg.key` 是无效的?
257271

258-
### 7.1 ANSI编码
272+
### 7.1 ANSI 编码
259273

260274
`test1` 以及 `test2` 生成的许可文本,均是 **ANSI 编码,目前已经支持空格** [Issues #5](https://github.com/bitcookies/winrar-keygen/issues/5)
261275

@@ -265,7 +279,7 @@ winrar-keygen.exe <text1> <text2>
265279

266280
具体可参考原理文档:[授权文件"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)
267281

268-
### 7.2 TXT编码
282+
### 7.2 TXT 编码
269283

270284
如果你使用了如下命令:
271285

@@ -281,7 +295,7 @@ winrar-keygen.exe "Github" "Github.com" > rarreg.key
281295
winrar-keygen.exe "Github" "Github.com" | Out-File -Encoding ASCII rarreg.key
282296
```
283297

284-
### 7.3 Key的位置
298+
### 7.3 Key 的位置
285299

286300
如果你无法执行拖动操作,你可以尝试把 `rarreg.key` 放在以下目录中:
287301

0 commit comments

Comments
 (0)