wood/clash-and-dashboard
1
0
Fork 0
mirror of https://github.com/woodchen-ink/clash-and-dashboard.git synced 2025-07-18 05:51:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Chore: add a simple contribution guide (#85)

Browse Source
This commit is contained in:
Rick 2021-11-27 22:21:34 +08:00 committed by GitHub
parent bdd3756821
commit a444adae43
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTION.md Normal file
View File

@ -0,0 +1,15 @@
Welcome to join us. Please read the following instructions to setup your local development environment.
First, install `pnpm` according to [the official document](https://pnpm.io/installation).
then, install some necessary depdencies:
```shell
pnpm install
```
you can run it once you have finished it.
```shell
pnpm start
```

2
README.md
View File

@ -26,6 +26,8 @@ See [Projects](https://github.com/Dreamacro/clash-dashboard/projects)
### Start develop with ClashX(Dev Mode) ### Start develop with ClashX(Dev Mode)
You can setup your local development environment with [the contribution guide](CONTRIBUTION.md).
```bash ```bash
# Enable ClashX with Dev Mode # Enable ClashX with Dev Mode
defaults write com.west2online.ClashX kEnableDashboard -bool YES defaults write com.west2online.ClashX kEnableDashboard -bool YES