Skip to content

Commit f19ee6e

Browse files
docs: add electron installation guide (#155)
Co-authored-by: Arlo <[email protected]>
1 parent 96b6f2f commit f19ee6e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/guide/contributing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,17 @@ After cloning the repo, run:
1414
$ pnpm i # install the dependencies of the project
1515
```
1616

17+
:::tip ⚠️
18+
19+
Since `electron` is used in the project, if your network environment is unstable, you may be unable to install dependencies.
20+
You can use the following command to set up the mirror, and run `pnpm i` again to install the dependencies.
21+
22+
```bash
23+
pnpm config set ELECTRON_MIRROR https://npmmirror.com/mirrors/electron/
24+
```
25+
26+
:::
27+
1728
## Git Hooks
1829

1930
The project uses [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) to enforce the following on each commit:

0 commit comments

Comments
 (0)