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 README: Change go get to go install for Go 1.16+ compatibility #20

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

Conversation

papack
Copy link

@papack papack commented Oct 7, 2024

This PR updates the installation instructions in the README to reflect the changes introduced in Go 1.16. The current go get command no longer installs the binary when using the module mode, which is now the default for Go.

The proposed change uses go install:

go install github.com/robertkrimen/godocdown/godocdown@latest

This will ensure that the binary is correctly installed to GOBIN (or GOPATH/bin if GOBIN is not set).

Why this change is necessary:

  • The go get command as it currently stands in the README only downloads the source code without installing the executable in Go 1.16+.
  • Using go install is the recommended way to install binaries from a module in Go 1.16 and later.

update install command
update install command
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.

1 participant