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: update instructions to install CLI #68

Merged
merged 1 commit into from
Dec 25, 2023

Conversation

MarkLodato
Copy link
Contributor

  • Fix the go get command, explaining that it now only works for installing libraries, and add the now-mandatory @<version> suffix.
  • Add instructions for using go install to run the binary.

@nigeltao
Copy link
Contributor

@dmitshur two questions.

  1. Can you remind me whether github.com/golang/foo PRs need a CLA?
  2. Is the @latest in go get github.com/golang/snappy@latest an idiomatic recommendation?

@dmitshur
Copy link

dmitshur commented Nov 17, 2022

@nigeltao Yes, I expect a passing CLA check is required (though I'm less familiar with snappy-specific details compared to the more common golang.org/x repos). This PR has it passing from looking at the Checks tab. We should ideally configure this repo's branch protection to require that check, so it's more clear.

For 2, I think it is better to leave out @latest from the go get command, and keep it as just go get github.com/golang/snappy. In supported versions of Go that defaults to @upgrade, which is very similar to @latest but behaves slightly better in rare edge cases. (It is good and necessary to include @latest in the go install command.)
So my suggestion is to keep go get github.com/golang/snappy and add go install github.com/golang/snappy/cmd/snappytool@latest.

- Add instructions for using `go install` to run the binary.
- Note that `go get` is only for use as a library.
@MarkLodato
Copy link
Contributor Author

Done. PTAL. Thanks for the prompt review!

@nigeltao nigeltao merged commit 43d5d4c into golang:master Dec 25, 2023
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

3 participants