From 8cd1e40fb3b6d1463b09e5cb8bc928bf06a774ac Mon Sep 17 00:00:00 2001 From: Larvan2 <78135608+Larvan2@users.noreply.github.com> Date: Fri, 20 Jan 2023 17:13:32 +0800 Subject: [PATCH] Update README.md --- .github/workflows/prerelease.yml | 5 ++++- README.md | 13 +++++++++---- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index e32cdce0..456039df 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -2,6 +2,9 @@ name: Prerelease on: workflow_dispatch: push: + paths: + - '!README.md' + - '!docs/**' branches: - Alpha - Beta @@ -186,4 +189,4 @@ jobs: tag_name: Prerelease-${{ github.ref_name }} files: bin/* prerelease: true - generate_release_notes: true \ No newline at end of file + generate_release_notes: true diff --git a/README.md b/README.md index 321ce97e..f1f10151 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ - Netfilter TCP redirecting. Deploy Clash on your Internet gateway with `iptables`. - Comprehensive HTTP RESTful API controller -## Getting Started -Documentations are now moved to [GitHub Wiki](https://github.com/Dreamacro/clash/wiki). +## Wiki +Documentation is available on [Clash.Meta Wiki](https://docs.metacubex.one/). ## Advanced usage for this branch @@ -49,11 +49,16 @@ If you can't visit github,you should set proxy first: go env -w GOPROXY=https://goproxy.io,direct ``` -So now you can build it: +Now you can build it: ```shell go build ``` +If you need gvisor for tun stack, build with: +```shell +go build -tags with_gvisor +``` + ### DNS configuration Support `geosite` with `fallback-filter`. @@ -110,7 +115,7 @@ Built-in [Wintun](https://www.wintun.net) driver. # Enable the TUN listener tun: enable: true - stack: gvisor # only gvisor + stack: system # system/gvisor dns-hijack: - 0.0.0.0:53 # additional dns server listen on TUN auto-route: true # auto set global route