zhangyuheng/ClashX
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
yicheng 2020-04-24 21:08:29 +08:00
parent 4232931c26
commit d1ef34e0a2
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -20,7 +20,9 @@ A rule based proxy For Mac base on [Clash](https://github.com/Dreamacro/clash).
## Install
You can download from [release](https://github.com/yichengchen/clashX/releases) page
You can download from [Release](https://github.com/yichengchen/clashX/releases) page
Download ClashX Pro With enhanced mode and other advance feature at [AppCenter](https://install.appcenter.ms/users/clashx/apps/clashx/distribution_groups/public).
## Build
- Make sure have python3 and golang installed in your computer.
@ -39,11 +41,16 @@ The default configuration directory is `$HOME/.config/clash`
The default name of the configuration file is `config.yaml`. You can use your custom config name and switch config in menu `Config` section.
To Change the ports of ClashX, you need to modify the `config.yaml` file. The `General` section settings in your custom config file would be ignored.
Checkout [Clash](https://github.com/Dreamacro/clash) or [SS-Rule-Snippet for Clash](https://github.com/Hackl0us/SS-Rule-Snippet/blob/master/LAZY_RULES/clash.yaml) for more detail.
Checkout [Clash](https://github.com/Dreamacro/clash) or [SS-Rule-Snippet for Clash](https://github.com/Hackl0us/SS-Rule-Snippet/blob/master/LAZY_RULES/clash.yaml) or [lancellc's gitbook](https://lancellc.gitbook.io/clash/) for more detail.
## Advance Config
### Change the ports of ClashX
Please modify the `config.yaml` file generated by ClashX, not the other config file you created or downloaded. The `General` section settings in your custom config file would be ignored.
### Change your status menu icon
Place your icon file in the `~/.config/clash/menuImage.png` then restart ClashX