README.md modified #120
Merged
README.md modified #120
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AmanGupta677
requested review from
robbles,
bvanvugt and
chris-bsnake
as code owners
robbles
approved these changes
Dec 15, 2022
| @@ -9,12 +9,12 @@ Download precompiled binaries here: <br> | |||
|
|
|||
| Install as a Go package. Requires Go 1.18 or higher. [[Download](https://golang.org/dl/)] | |||
| ``` | |||
| go get github.com/BattlesnakeOfficial/rules/cli/battlesnake | |||
| go install github.com/BattlesnakeOfficial/rules/cli/battlesnake@latest | |||
There was a problem hiding this comment.
👍 Thanks for catching this.
| ``` | ||
|
|
||
| Compile from source. Also requires Go 1.18 or higher. | ||
| ``` | ||
| git clone git@github.com:BattlesnakeOfficial/rules.git | ||
| git clone https://github.com/BattlesnakeOfficial/rules.git |
There was a problem hiding this comment.
FYI - this isn't really the "wrong" URL, it's just the one that uses your locally configured SSH credentials.
Check out this page for more info on how to set it up yourself:
https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh
However, I do think using the HTTPS URL is better for this use case, because the error you see if you don't have the key set up is confusing.
There was a problem hiding this comment.
Thanks for the helpful suggestion! I will definitely improve this.🙌
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After the go 1.17 update the "go get" command is deprecated "go install" is being used instead. and the URL of the git repository was wrong.
