Skip to content

Commit

Permalink
*: tiny update CONTRIBUTING.md (#8814)
Browse files Browse the repository at this point in the history
  • Loading branch information
tiancaiamao authored and zz-jason committed Jan 14, 2019
1 parent 4b98ad6 commit 53707ce
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,25 @@ please [set one up](http://golang.org/doc/code.html).

The version of GO should be **1.11** or above.

After installation, you'll need `GOPATH` defined,
and `PATH` modified to access your Go binaries.
After installation, there are two ways to build TiDB binary.

#### For a quick taste

The `GOPATH` is not necessary.

```
mkdir tmp
cd tmp
echo 'module tidb' > go.mod
GO111MODULE=on go get github.com/pingcap/tidb@c385cbdcca83eeed283139814a7ea149e3116e66
GO111MODULE=on go build -o tidb-server github.com/pingcap/tidb/tidb-server
```

The `c385cbdcca83eeed283139814a7ea149e3116e66` can be changed to any other commit hash. Try the latest commit hash [here](https://github.com/pingcap/tidb/commits/master).

#### For development

You'll need `GOPATH` defined, and `PATH` modified to access your Go binaries.

A common setup is the following but you could always google a setup for your own flavor.

Expand Down

0 comments on commit 53707ce

Please sign in to comment.