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

docs: add install instructions for cli use #206

Merged
merged 1 commit into from
May 16, 2024
Merged

Conversation

SgtPooki
Copy link
Member

@SgtPooki SgtPooki commented May 1, 2024

Fixes #184

Copy link
Member Author

@SgtPooki SgtPooki left a comment

Choose a reason for hiding this comment

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

self review

Comment on lines +68 to +69
$ # Install the gateway-conformance binary
$ go install github.com/ipfs/gateway-conformance/cmd/gateway-conformance@latest
Copy link
Member Author

Choose a reason for hiding this comment

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

For others like me, it might be useful to point to the go help install docs that mention where the binary will be installed:

Executables are installed in the directory named by the GOBIN environment
variable, which defaults to $GOPATH/bin or $HOME/go/bin if the GOPATH
environment variable is not set. Executables in $GOROOT
are installed in $GOROOT/bin or $GOTOOLDIR instead of $GOBIN.

Copy link
Member Author

Choose a reason for hiding this comment

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

it might be useful to mention adding $GOPATH/bin or $HOME/go/bin to PATH if the user is not already familiar with the Go ecosystem.

Copy link
Contributor

github-actions bot commented May 1, 2024

Results against Kubo master:
(check the action's summary for the full results)

Summary

Tests Failures Errors Skipped
2049 0 0 0

Copy link
Contributor

github-actions bot commented May 1, 2024

Results against Kubo latest:
(check the action's summary for the full results)

Summary

Tests Failures Errors Skipped
2049 0 0 0

@SgtPooki SgtPooki requested a review from lidel May 10, 2024 20:37
@SgtPooki SgtPooki merged commit 8664ec3 into main May 16, 2024
11 checks passed
@SgtPooki SgtPooki deleted the SgtPooki-patch-3 branch May 16, 2024 19:12
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.

docs: should add instructions to run from source
1 participant