Skip to content

Commit 4ad0692

Browse files
committed
Update README for Go 1.6.
1 parent a077a12 commit 4ad0692

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,16 @@ Longer term plans:
7676

7777
## Installation
7878

79-
First, you need to set up your environment.
79+
First, you need to have Go installed. You can either follow the official [installation instructions](https://golang.org/doc/install) or, on OS X, just do
80+
```sh
81+
brew install go
82+
```
8083

84+
As part of the initial setup, you have to set `GOPATH`, wihch is the location where Go keeps all its sources and binary artifacts.
8185
```sh
8286
export GOPATH=...
83-
export GO15VENDOREXPERIMENT=1
8487
```
8588

86-
This is the location where Go keeps all its sources and binary artifacts: the doorman executable binary will go to `$GOPATH/bin/doorman`. `$GO15VENDOREXPERIMENT` needs to be set to allow easy vendoring (see https://golang.org/s/go15vendor). It will cease to be necessary as of Go 1.6.
87-
8889
With this out of the way, Doorman is just one go get away:
8990

9091
```sh
@@ -98,6 +99,14 @@ mkdir -p $GOPATH/src/github.com/youtube
9899
git clone [email protected]:youtube/doorman.git
99100
```
100101

102+
### Go version <= 1.5
103+
104+
If you are using a version of Go earlier than 1.6, you will need to set an environment variable to enable vendoring (see https://golang.org/s/go15vendor):
105+
106+
```sh
107+
export GO15VENDOREXPERIMENT=1
108+
```
109+
101110
## Contributing
102111

103112
See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.

0 commit comments

Comments
 (0)