From 21cddb6d00cf503f36248d393018daafedc35d3b Mon Sep 17 00:00:00 2001 From: fanchenio Date: Wed, 8 Nov 2023 16:45:35 +0800 Subject: [PATCH] Change README --- README-ENGLISH.md | 11 ++++++----- README.md | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README-ENGLISH.md b/README-ENGLISH.md index 7fd746e..b5d72cb 100644 --- a/README-ENGLISH.md +++ b/README-ENGLISH.md @@ -20,11 +20,12 @@ Supports associated folders (real-time synchronization of folder contents), quic # Compilation Steps -1. First you need to install `node-gyp`, which is needed to compile local modules. -2. Then run `yarn install` to install the project dependencies (if you modify the `Rust` code, you need to re-run `yarn install`). -3. `yarn run dev` runs the project locally. -4. `yarn run build` packages the project. -5. The portable version and the installation version need to be packaged twice. By modifying `VITE_INSTALL` in `.env.production`, `true` means the installation version and `false` means the portable version. +1. Install `node-gyp`, required to compile SQLite3. +2. Install the `Rust` environment + `Cargo`, which is needed to compile Rust. +3. Then run `yarn install` to install the project dependencies (if you modify the `Rust` code, you need to re-run `yarn install`). +4. `yarn run dev` runs the project locally. +5. `yarn run build` packages the project. +6. The portable version and the installation version need to be packaged twice. By modifying `VITE_INSTALL` in `.env.production`, `true` means the installation version and `false` means the portable version. # Official Website diff --git a/README.md b/README.md index a90bb58..cac9cad 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,12 @@ # 编译步骤 -1. 首先需要安装`node-gyp`,编译本地模块需要用到。 -2. 然后运行`yarn install`安装项目依赖(如果修改了`Rust`代码也需要重新运行`yarn install`)。 -3. `yarn run dev`本地运行项目。 -4. `yarn run build`打包项目。 -5. 便携版和安装版需要分两次打包,通过修改`.env.production`中的`VITE_INSTALL`,`true`为安装版,`false`为便携版。 +1. 安装`node-gyp`,编译 SQLite3 需要。 +2. 安装`Rust`环境 + `Cargo`,编译 Rust 需要。 +3. 然后运行`yarn install`安装项目依赖(如果修改了`Rust`代码也需要重新运行`yarn install`)。 +4. `yarn run dev`本地运行项目。 +5. `yarn run build`打包项目。 +6. 便携版和安装版需要分两次打包,通过修改`.env.production`中的`VITE_INSTALL`,`true`为安装版,`false`为便携版。 # 官网