From 756e09c08326d25bac2044bfe1d449348655af5f Mon Sep 17 00:00:00 2001 From: baiwusanyu-c <740132583@qq.com> Date: Fri, 5 Jan 2024 17:52:02 +0800 Subject: [PATCH 1/3] docs: add electron installation guide --- docs/guide/contributing.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/guide/contributing.md b/docs/guide/contributing.md index dd945346..b06ad4a8 100644 --- a/docs/guide/contributing.md +++ b/docs/guide/contributing.md @@ -14,6 +14,17 @@ After cloning the repo, run: $ pnpm i # install the dependencies of the project ``` +:::tip ⚠️ + +Since `electron` is used in the project, if you are a developer in mainland China, you may not be able to install the dependencies. +You can use the following command to set up the mirror, and run `pnpm i` again to install the dependencies. + +```bash +pnpm config set ELECTRON_MIRROR https://npmmirror.com/mirrors/electron/ +``` + +::: + ## Git Hooks The project uses [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) to enforce the following on each commit: From 957f8e68f8744cc23677d3c3d0567d21b30fa81d Mon Sep 17 00:00:00 2001 From: baiwusanyu-c <740132583@qq.com> Date: Fri, 5 Jan 2024 18:12:11 +0800 Subject: [PATCH 2/3] chore: updated description content --- docs/guide/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/contributing.md b/docs/guide/contributing.md index b06ad4a8..98673db9 100644 --- a/docs/guide/contributing.md +++ b/docs/guide/contributing.md @@ -16,7 +16,7 @@ $ pnpm i # install the dependencies of the project :::tip ⚠️ -Since `electron` is used in the project, if you are a developer in mainland China, you may not be able to install the dependencies. +Since `electron` is used in the project, if your network environment is unstable, you may not be able to install dependencies. You can use the following command to set up the mirror, and run `pnpm i` again to install the dependencies. ```bash From e54aa2d3e7691b29ad1713c60874f399b6eaf877 Mon Sep 17 00:00:00 2001 From: Arlo Date: Sat, 6 Jan 2024 16:03:33 +0800 Subject: [PATCH 3/3] chore: update --- docs/guide/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/contributing.md b/docs/guide/contributing.md index 98673db9..6ebebf6a 100644 --- a/docs/guide/contributing.md +++ b/docs/guide/contributing.md @@ -16,7 +16,7 @@ $ pnpm i # install the dependencies of the project :::tip ⚠️ -Since `electron` is used in the project, if your network environment is unstable, you may not be able to install dependencies. +Since `electron` is used in the project, if your network environment is unstable, you may be unable to install dependencies. You can use the following command to set up the mirror, and run `pnpm i` again to install the dependencies. ```bash