Improve build instructions in README #245
Merged
Conversation
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
This drops the `setup_go_env_vars` script, which is only confusing. It contained three lines, of which only one (setting `GOPATH`) is always required and the other two are only relevant when go is manually installed. In the most common case (go installed through a package manager), they will even break the build. Instead of referring to an external script, just show how to set `GOPATH` in the README itself. This improvement was prompted by the user confusion found in arduino#244. Signed-off-by: Matthijs Kooijman <matthijs@stdin.nl>
Closed
|
✅ Build completed. ⬇️ Build URL: ℹ️ To test this build:
|
facchinm
approved these changes
Sep 4, 2017
|
Since this is a fairly trivial change, that becomes useful as soon as it is merged (not only after a release), perhaps this can be merged already? @facchinm ? |
|
Totally agree, merging right now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This drops the
setup_go_env_varsscript, which is only confusing. Itcontained three lines, of which only one (setting
GOPATH) is alwaysrequired and the other two are only relevant when go is manually
installed. In the most common case (go installed through a package
manager), they will even break the build.
Instead of referring to an external script, just show how to set
GOPATHin the README itself.This improvement was prompted by the user confusion found in #244.
Signed-off-by: Matthijs Kooijman matthijs@stdin.nl