Skip to content

Commit

Permalink
docs: add new parameters -n and -m for queue
Browse files Browse the repository at this point in the history
  • Loading branch information
boxsnake committed Apr 23, 2022
1 parent 9c9ec60 commit ee2e416
Showing 1 changed file with 25 additions and 32 deletions.
57 changes: 25 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,67 +8,60 @@
1. 此准备工作仅需运行一次

2.[Node.js](https://nodejs.org/en/) 站点下载 Node.js 并安装

1. 建议版本 >= 14
2. 不建议安装奇数版本,如 13、15、17,奇数版本由于没有充分的进行测试,为不稳定版本

3. 安装 Node.js 之后,打开命令提示符,依次输入:

```bash
node -v
npm --version
```

此操作会输出两个版本号,表示安装成功,如果没有版本号输出请重新安装 Node.js

4. 鉴于 `npm` 工具使用存在一些问题,推荐使用 `yarn` 工具,打开命令提示符,输入以下命令并等待安装完成:

```bash
npm i -g yarn
```

5. 此文档中会提供 `npm``yarn` 两套命令,根据你使用的工具,只需执行其中一句即可

## 术语解释

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

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

1. 打开命令提示符(CMD.exe)

2. 使用 `cd` 命令切换到解压后的工具目录

1. Windows 中:

```bash
cd /d <工具路径>
```

2. Linux / Unix / MacOS 中:

```bash
cd /d <工具路径>
cd /d <工具路径> # Windows 命令
cd <工具路径> # Linux / Unix / MacOS 命令
```

3. 运行以下命令,等待依赖包安装完成:
2. 运行以下命令,等待依赖包安装完成:

```bash
npm i
yarn install
```

4. 运行以下命令,进行文件对比,生成报告
3. 运行以下命令,进行文件对比,生成报告

```bash
npm run compare -- -l <左文件夹路径> -r <右文件夹路径> -o <报告文件夹路径>
yarn compare -l <左文件夹路径> -r <右文件夹路径> -o <报告文件夹路径>
npm run compare -- ...参数
yarn compare ...参数
```
参数说明:

| 参数标记 | 是否必填 | 默认值 | 说明 |
| :--- | :---: | :--- | :--- |
| `--lhs-queue`<br>`-n` || `10` | 计算左侧文件数字签名时,同时进行的任务数量,越多则执行越快,但消耗资源也会越多 |
| `--lhs`<br>`-l` || | 左侧对比文件夹路径 |
| `--rhs-queue`<br>`-m` || `10` | 计算右侧文件数字签名时,同时进行的任务数量,越多则执行越快,但消耗资源也会越多 |
| `--rhs`<br>`-r` || | 右侧对比文件夹路径 |
| `--output`<br>`-o` || | 报告生成的文件夹路径 |

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

## 报告文件说明

Expand Down

0 comments on commit ee2e416

Please sign in to comment.