Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: simplify installation instructions with go get. #41

Merged
merged 4 commits into from
Feb 28, 2018

Conversation

cpu
Copy link
Contributor

@cpu cpu commented Feb 27, 2018

Prior to this commit the installation instructions in the README had you
use git clone and then go build. This can be collapsed into one step
using a more idiomatic go get command. This commit updates the README
accordingly.

Edit: I also snuck in a commit ( 670ed03 ) to document the two locations a
config file can be placed. Happy to split this off into a separate PR if preferred.

Prior to this commit the installation instructions in the README had you
use `git clone` and then `go build`. This can be collapsed into one step
using a more idiomatic `go get` command. This commit updates the README
accordingly.
@coveralls
Copy link

coveralls commented Feb 27, 2018

Coverage Status

Coverage remained the same at 92.373% when pulling c9f9a9c on cpu:cpu-simplify-readme into 830cceb on joohoi:master.

@MrBMT
Copy link

MrBMT commented Feb 28, 2018

@cpu The command in your initial pull request should be:
go get github.com/joohoi/acme-dns/...
Rather than:
go get https://github.com/joohoi/acme-dns/...

Otherwise you'll be presented with the following error:

package https:/github.com/joohoi/acme-dns/...: "https://" not allowed in import path

Cheers

@cpu
Copy link
Contributor Author

cpu commented Feb 28, 2018

@cpu The command in your initial pull request should be:
go get github.com/joohoi/acme-dns/...

@MrBMT Oops! You're correct :-) That's the go get in my shell history, I made an editorial mistake preserving the https:// URL when I was putting it in the README. Fixed in c9f9a9c, thank you for catching that!

@joohoi
Copy link
Owner

joohoi commented Feb 28, 2018

Thanks for the PR @cpu and for the intial review @MrBMT ;) It's awesome to have someone to check and make the instructions better!

@joohoi joohoi merged commit 11c852e into joohoi:master Feb 28, 2018
@cpu cpu deleted the cpu-simplify-readme branch February 28, 2018 19:27
jacobmyers-codeninja pushed a commit to jacobmyers-codeninja/acme-dns that referenced this pull request Sep 30, 2020
* README: simplify installation instructions with `go get`.

Prior to this commit the installation instructions in the README had you
use `git clone` and then `go build`. This can be collapsed into one step
using a more idiomatic `go get` command. This commit updates the README
accordingly.

* Also mention supported config file locations

* Fix go get URL
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants