Skip to content

Update installation instructions for latest Go version #10

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

Merged
merged 1 commit into from
Oct 24, 2022

Conversation

justincampbell
Copy link
Contributor

go install is now required when not running from within a module, and the subcommand path is required as the root is not a main package.

`go install` is now required when not running from within a module.
@hmarr
Copy link
Owner

hmarr commented Oct 24, 2022

That line actually refers to how to install this module as a library rather than the CLI tool, but I agree it's probably a bit confusing to have them next to each other.

Can I propose a slightly bigger change instead?

  • Have two <h2> level headings — "CLI tool" and "Go library"
  • Under each of those, have <h3> headings for "Installation" and "Usage"
  • Under the "Installation" heading for the CLI section, show both the homebrew install instructions and "from source" install instructions using go install
  • Move the go get command to the "Go library" section

WDYT?

@justincampbell
Copy link
Contributor Author

That sounds good! Feel free to take merge or close this and do whichever you wish. I only submitted the change because the other instructions didn't work when I tried to install it for CLI usage. Thanks!

@hmarr hmarr merged commit 852773f into hmarr:main Oct 24, 2022
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