aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Brian Bao <brianbao@users.noreply.github.com> 2019-02-09 09:40:54 -0500
committerGravatar Miek Gieben <miek@miek.nl> 2019-02-09 14:40:54 +0000
commitc2133ce6b14119748f5518514a3ef1141b3f9225 (patch)
tree4f5287f00037c32c5c68e1868744cca94382e972 /README.md
parent67932239489d955a0af69b41d78282ad5ed29a34 (diff)
downloadcoredns-c2133ce6b14119748f5518514a3ef1141b3f9225.tar.gz
coredns-c2133ce6b14119748f5518514a3ef1141b3f9225.tar.zst
coredns-c2133ce6b14119748f5518514a3ef1141b3f9225.zip
Update README.md on compiling from GitHub (#2543)
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index 73bd85ae4..bc57ffa43 100644
--- a/README.md
+++ b/README.md
@@ -44,24 +44,24 @@ out-of-tree plugins.
## Compilation from Source
-Check out the project:
+To compile CoreDNS, we assume you have a working Go setup. See various tutorials if you don’t have that already configured.
-~~~
-% git clone https://github.com/coredns/coredns
-~~~
-
-We vendor most (not all!) packages. This is mostly because vendoring isn't a perfect solution (in
-Go). We don't vendor `mholt/caddy` and `miekg/dns` for instance. Using `make` will pull down these
-dependencies and checks out the correct version as well.
-
-Next just run `make`:
+First, make sure your `$GOPATH` is correctly set. See [here](https://github.com/golang/go/wiki/SettingGOPATH) for details. Then, check out the project under your `$GOPATH` and run `make` to compile the binary:
~~~
-% make
+$ mkdir -p $GOPATH/src/github.com/coredns
+$ cd $GOPATH/src/github.com/coredns/
+$ git clone https://github.com/coredns/coredns
+$ cd coredns
+$ make
~~~
This should yield a `coredns` binary.
+We vendor most ([not all!](https://github.com/coredns/coredns/issues/1523)) packages. This is mostly because vendoring isn't a perfect solution (in
+Go). We don't vendor `mholt/caddy` and `miekg/dns` for instance. Using `make` will pull down these
+dependencies and checks out the correct version as well.
+
## Compilation with Docker
CoreDNS requires Go to compile. However, if you already have docker installed and prefer not to setup