Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fortuna committed Dec 17, 2018
1 parent 080273d commit e820258
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,25 @@ Run the iperf3 client tests listed above on port 10002.

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

## Benchmark

You can benchmark the cipher finding code with
```
go test -cpuprofile cpu.prof -memprofile mem.prof -bench . -benchmem -run=^$ github.com/Jigsaw-Code/outline-ss-server/shadowsocks
```

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.

## Release

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

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

To test locally without tagging/uploading , use `--skip-publish`:
```bash
goreleaser --skip-publish
```

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 comments on commit e820258

Please sign in to comment.