Skip to content

Commit

Permalink
Merge pull request #5 from kongying-tavern/dev
Browse files Browse the repository at this point in the history
更新文档
  • Loading branch information
boxsnake authored Jul 19, 2024
2 parents 39e530c + 3cc3a6e commit 78e9fd6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ logs
npm-debug.log*
package-lock.json*
yarn.lock*
pnpm-lock.yaml
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,28 @@

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

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

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

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

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

4. 鉴于 `npm` 工具使用存在一些问题,推荐使用 `yarn` 工具,打开命令提示符,输入以下命令并等待安装完成
4. 此处推荐使用 `pnpm` 工具。高版本 `Node.js` 自带 `pnpm`,但需手动开启。打开命令提示符,输入以下命令以开启 `pnpm`

```bash
npm i -g yarn
corepack enable
```

5. ****:此文档中会提供 `npm``yarn` 两套命令,根据你使用的工具,只需执行其中一句即可
5. ****
- `npm``Node.js` 的包管理工具;此外,上述步骤会开启 `yarn``pnpm` 包管理工具。
- 此文档中会提供 `npm``pnpm``yarn` 三套命令,根据你使用的工具,只需执行其中一句即可。

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

```bash
npm i
pnpm i
yarn install
```

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

```bash
npm run compare -- ...参数
pnpm run compare ...参数
yarn compare ...参数
```
Expand Down

0 comments on commit 78e9fd6

Please sign in to comment.