Skip to content

Commit e820258

Browse files
committed
Update README
1 parent 080273d commit e820258

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,25 @@ Run the iperf3 client tests listed above on port 10002.
107107

108108
You can mix and match the libev and go servers and clients.
109109

110+
## Benchmark
111+
112+
You can benchmark the cipher finding code with
113+
```
114+
go test -cpuprofile cpu.prof -memprofile mem.prof -bench . -benchmem -run=^$ github.com/Jigsaw-Code/outline-ss-server/shadowsocks
115+
```
116+
117+
You can inspect the CPU or memory profiles with `go tool pprof cpu.prof` or `go tool pprof mem.prof`, and then enter `web` on the prompt.
110118

111119
## Release
112120

113121
We use [GoReleaser](https://goreleaser.com/) to build and upload binaries to our [GitHub releases](https://github.com/Jigsaw-Code/outline-ss-server/releases).
114122

115123
Summary:
116124
- [Install GoReleaser](https://goreleaser.com/install/).
125+
- Test the build locally:
126+
```
127+
goreleaser --rm-dist --snapshot
128+
```
117129
- Export an environment variable named `GITHUB_TOKEN` with a repo-scoped GitHub token ([create one here](https://github.com/settings/tokens/new)):
118130
```bash
119131
export GITHUB_TOKEN=yournewtoken
@@ -128,9 +140,4 @@ Summary:
128140
goreleaser
129141
```
130142

131-
To test locally without tagging/uploading , use `--skip-publish`:
132-
```bash
133-
goreleaser --skip-publish
134-
```
135-
136143
Full instructions in [GoReleaser's Quick Start](https://goreleaser.com/quick-start) (jump to the section starting "You’ll need to export a GITHUB_TOKEN environment variable").

0 commit comments

Comments
 (0)