docs: add Install section (fixes "go install ... does not contain package")#44
Merged
Conversation
…age" error
Users had no documented install command and guessed
`go install github.com/Kernel-Guard/bpfcompat@latest`, which fails with
"module ... found, but does not contain package ..." for two reasons:
the main package lives in cmd/bpfcompat (not the module root), and the
module path is lowercase (github.com/kernel-guard/bpfcompat) while the
GitHub org is Kernel-Guard.
Add an Install section to the README documenting three verified paths:
1. prebuilt release binary + static validator (checksum-verified)
2. from source (make build && make validator-static)
3. go install github.com/kernel-guard/bpfcompat/cmd/bpfcompat@latest
(CLI only; note lowercase module + cmd subpath)
Point quickstart's local-CLI section at it. All three commands tested.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
A user hit:
Root causes (both reproduced):
mainpackage is incmd/bpfcompat, not the module root —go install <module>@latestfinds no package.github.com/kernel-guard/bpfcompat, while the GitHub org isKernel-Guard; the capital form fails with a module-path-mismatch error.There was no documented install command anywhere, so users guessed the failing form.
Fix
Add an Install section to the README with three verified paths, and point the quickstart's local-CLI section at it:
make build && make validator-static.go install—go install github.com/kernel-guard/bpfcompat/cmd/bpfcompat@latest(lowercase module +cmdsubpath; CLI only, reports0.1.0-devsince ldflags aren't injected).Verification
All three commands run clean against
v0.1.6:sha256sum -c --ignore-missing→ OK,bpfcompat version→v0.1.6go install .../cmd/bpfcompat@v0.1.6→ builds a runnable binary🤖 Generated with Claude Code