diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..2973e05 --- /dev/null +++ b/CONTRIBUTION.md @@ -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 +``` diff --git a/README.md b/README.md index 311a770..1154f7c 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ See [Projects](https://github.com/Dreamacro/clash-dashboard/projects) ### Start develop with ClashX(Dev Mode) +You can setup your local development environment with [the contribution guide](CONTRIBUTION.md). + ```bash # Enable ClashX with Dev Mode defaults write com.west2online.ClashX kEnableDashboard -bool YES