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.

Sign up for GitHub

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.md modified #120

Merged
merged 1 commit into from
Dec 15, 2022
Merged

README.md modified #120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the helpful suggestion! I will definitely improve this.🙌

cd rules
go build -o battlesnake ./cli/battlesnake/main.go
```
Expand Down