aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2019-01-09 09:28:08 +0000
committerGravatar GitHub <noreply@github.com> 2019-01-09 09:28:08 +0000
commit0efa99e9543fd28d3196c38b1fdd094e83cc23b8 (patch)
tree988e0c54dbd0783e20706e5802ca7a0a2e519e77 /README.md
parent18f25dbef3a33092925e48e7d7f9c8d8f744cd05 (diff)
downloadcoredns-0efa99e9543fd28d3196c38b1fdd094e83cc23b8.tar.gz
coredns-0efa99e9543fd28d3196c38b1fdd094e83cc23b8.tar.zst
coredns-0efa99e9543fd28d3196c38b1fdd094e83cc23b8.zip
docs: update the compile-from-source section (#2449)
You can't go get coredns - update this section. Signed-off-by: Miek Gieben <miek@miek.nl>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index b059e9f47..1c3ccae21 100644
--- a/README.md
+++ b/README.md
@@ -44,15 +44,17 @@ out-of-tree plugins.
## Compilation from Source
-Check out the project and do dependency resolution with:
+Check out the project:
~~~
-% go get github.com/coredns/coredns
+% git clone https://github.com/coredns/coredns
~~~
-Some of the dependencies require Go version 1.9 or later.
+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 check out the correct version as well.
-We vendor most (not all!) packages. Building from scratch is easiest, by just using `make`:
+Next just run `make`:
~~~
% make
@@ -197,4 +199,4 @@ If you find a security vulnerability or any security related issues, please DO N
issue, instead send your report privately to `security@coredns.io`. Security reports are greatly
appreciated and we will publicly thank you for it.
-Please consult [security vulnerability disclosures and security fix and release process document](https://github.com/coredns/coredns/SECURITY-RELEASE-PROCESS.md) \ No newline at end of file
+Please consult [security vulnerability disclosures and security fix and release process document](https://github.com/coredns/coredns/SECURITY-RELEASE-PROCESS.md)