Skip to content

Commit ee2e416

Browse files
committed
docs: add new parameters -n and -m for queue
1 parent 9c9ec60 commit ee2e416

File tree

1 file changed

+25
-32
lines changed

1 file changed

+25
-32
lines changed

README.md

+25-32
Original file line numberDiff line numberDiff line change
@@ -8,67 +8,60 @@
88
1. 此准备工作仅需运行一次
99

1010
2.[Node.js](https://nodejs.org/en/) 站点下载 Node.js 并安装
11-
11+
1212
1. 建议版本 >= 14
1313
2. 不建议安装奇数版本,如 13、15、17,奇数版本由于没有充分的进行测试,为不稳定版本
1414

1515
3. 安装 Node.js 之后,打开命令提示符,依次输入:
16-
16+
1717
```bash
1818
node -v
1919
npm --version
2020
```
21-
21+
2222
此操作会输出两个版本号,表示安装成功,如果没有版本号输出请重新安装 Node.js
2323

2424
4. 鉴于 `npm` 工具使用存在一些问题,推荐使用 `yarn` 工具,打开命令提示符,输入以下命令并等待安装完成:
25-
25+
2626
```bash
2727
npm i -g yarn
2828
```
2929

30-
5. 此文档中会提供 `npm``yarn` 两套命令,根据你使用的工具,只需执行其中一句即可
31-
32-
## 术语解释
33-
34-
1. 工具 - 指代此工具
35-
2. 左文件夹(左目录) - 用于比较的原文件夹
36-
3. 右文件夹(右目录) - 进行对比的文件夹
37-
4. 报告文件夹(报告目录) - 报告文件输出的文件夹
30+
5. ****:此文档中会提供 `npm``yarn` 两套命令,根据你使用的工具,只需执行其中一句即可
3831

3932
## 使用方法
33+
1. Windows 下打开命令提示符(`CMD.exe`),Linux / Unix / MacOS 下打开终端,使用 `cd` 命令切换到解压后的工具目录
4034

41-
1. 打开命令提示符(CMD.exe)
42-
43-
2. 使用 `cd` 命令切换到解压后的工具目录
44-
45-
1. Windows 中:
46-
4735
```bash
48-
cd /d <工具路径>
49-
```
50-
51-
2. Linux / Unix / MacOS 中:
52-
53-
```bash
54-
cd /d <工具路径>
36+
cd /d <工具路径> # Windows 命令
37+
cd <工具路径> # Linux / Unix / MacOS 命令
5538
```
5639

57-
3. 运行以下命令,等待依赖包安装完成:
58-
40+
2. 运行以下命令,等待依赖包安装完成:
41+
5942
```bash
6043
npm i
6144
yarn install
6245
```
6346

64-
4. 运行以下命令,进行文件对比,生成报告
65-
47+
3. 运行以下命令,进行文件对比,生成报告
48+
6649
```bash
67-
npm run compare -- -l <左文件夹路径> -r <右文件夹路径> -o <报告文件夹路径>
68-
yarn compare -l <左文件夹路径> -r <右文件夹路径> -o <报告文件夹路径>
50+
npm run compare -- ...参数
51+
yarn compare ...参数
52+
6953
```
54+
参数说明:
55+
56+
| 参数标记 | 是否必填 | 默认值 | 说明 |
57+
| :--- | :---: | :--- | :--- |
58+
| `--lhs-queue`<br>`-n` || `10` | 计算左侧文件数字签名时,同时进行的任务数量,越多则执行越快,但消耗资源也会越多 |
59+
| `--lhs`<br>`-l` || | 左侧对比文件夹路径 |
60+
| `--rhs-queue`<br>`-m` || `10` | 计算右侧文件数字签名时,同时进行的任务数量,越多则执行越快,但消耗资源也会越多 |
61+
| `--rhs`<br>`-r` || | 右侧对比文件夹路径 |
62+
| `--output`<br>`-o` || | 报告生成的文件夹路径 |
7063

71-
5. 报告文件生成在报告文件夹,如果报告文件不存在会自动生成,具体文件的作用请参照报告文件说明部分
64+
4. 报告文件生成在报告文件夹,如果报告文件不存在会自动生成,具体文件的作用请参照报告文件说明部分
7265

7366
## 报告文件说明
7467

0 commit comments

Comments
 (0)