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

Update installation instructions #18

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

BoKleynen
Copy link

Installing executables using go get is nog longer supported as of go 1.18, from the official release notes:

go get no longer builds or installs packages in module-aware mode. go get is now dedicated to adjusting dependencies in go.mod. Effectively, the -d flag is always enabled. To install the latest version of an executable outside the context of the current module, use go install example.com/cmd@latest. Any version query may be used instead of latest. This form of go install was added in Go 1.16, so projects supporting older versions may need to provide install instructions for both go install and go get. go get now reports an error when used outside a module, since there is no go.mod file to update. In GOPATH mode (with GO111MODULE=off), go get still builds and installs packages, as before.

README.md Outdated
Comment on lines 10 to 19
### go 1.16+

```sh
go install github.com/jdeflander/goarrange@v1.0.0
```

### pre go 1.16

```sh
$ go get github.com/jdeflander/goarrange
go get github.com/jdeflander/goarrange
Copy link
Owner

Choose a reason for hiding this comment

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

I previously added the $ prompt to distinguish between terminal input and output (mainly useful in the usage example), so I would either drop it or keep it everywhere for consistency.

Copy link
Author

Choose a reason for hiding this comment

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

I removed it here to make copy-pasting easier (yeah i'm that lazy), but for consistency it's probably better to readd the $ everywhere then because otherwise you won't be able to make that distinction in the usage section.

@BoKleynen BoKleynen requested a review from jdeflander June 24, 2022 08:54
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.

2 participants