aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Chris West <solo-github@goeswhere.com> 2017-09-13 22:03:56 +0100
committerGravatar John Belamaric <jbelamaric@infoblox.com> 2017-09-13 17:03:56 -0400
commit0fc4a895446889a1e1794404035e8348447390a7 (patch)
treeadaaaaa322b123f1cd219826cb9bb3d024703134 /README.md
parent43587e8c502c9f1147aed623e851a4fd5a540ce4 (diff)
downloadcoredns-0fc4a895446889a1e1794404035e8348447390a7.tar.gz
coredns-0fc4a895446889a1e1794404035e8348447390a7.tar.zst
coredns-0fc4a895446889a1e1794404035e8348447390a7.zip
Add non-Go-user friendly build instructions (#1071)
Go is not super helpful if you checkout the code to a random path, then try and follow the build instructions in the README. Add some instructions that help users who don't deal with Go on a day-to-day basis to get it right. Fixes #1070. Thanks to @johnbelamaric for reminding me about Go's deficiencies.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index f4d6e6c78..eeef2f3e0 100644
--- a/README.md
+++ b/README.md
@@ -65,16 +65,21 @@ Caddyfile when forked).
## Compilation
CoreDNS (as a servertype plugin for Caddy) has a dependency on Caddy, but this is not different than
-any other Go dependency. If you have the source of CoreDNS, get all dependencies:
+any other Go dependency. If you have the source of CoreDNS checked out in the appropriate place in
+your `GOPATH`, get all dependencies:
go get ./...
+(You can do the checkout and dependency resolution as a single step with: `go get github.com/coredns/coredns`.)
+
And then `go build` as you would normally do:
go build
This should yield a `coredns` binary.
+Note that CoreDNS currently requires at least Go 1.9 to build.
+
## Examples
When starting CoreDNS without any configuration, it loads the `whoami` middleware and starts