docs: note Windows install needs Go on PATH (follow-up to #45)#46
Merged
Conversation
The Windows build step compiles from source with the Go toolchain and has no prebuilt-binary fallback like the Linux/macOS sh script, so Windows installs require Go on PATH. Document that in the README and the installation docs, and refresh the now-stale "not tested on Windows" / Linux+macOS-only platform lines now that Windows is supported and validated against herdr's Windows beta.
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.
Follow-up to #45 (Windows support).
Windows now works, but its build step compiles straight from source with the Go toolchain — there's no prebuilt-binary fallback like the Linux/macOS
shscript has — so Go must be on the user'sPATHtoherdr plugin installon Windows. That wasn't documented anywhere, so a Windows user would hit a confusing failure.Changes
amd64(.zip), validated against herdr's Windows beta.Docs only — no code changes.