README: Document supported GOOS values. #777
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
Add instructions for what people should do when building with GopherJS on unsupported platforms. Code generation works completely fine, but syscalls (e.g., for gopherjs run) will only work on supported platforms. Previously, this information was only in issues, people's heads, commit messages, etc. It should be documented in README to provide clarity. Rename "OS X" to "macOS", the current name of that operating system. Rearrange sections to place more relevant information first. Mention Linux before macOS consistently. Linux is placed first because it's open source and more freely available than the proprietary macOS, so it's easier to recommend it as an alternative. Resolves #770. Updates #776. Updates #688.
neelance
reviewed
Mar 17, 2018
README.md
Outdated
| @@ -31,7 +33,7 @@ If you want to use `gopherjs run` or `gopherjs test` to run the generated code l | |||
| npm install --global source-map-support | |||
| ``` | |||
|
|
|||
| For system calls (file system access, etc.), see [this page](https://github.com/gopherjs/gopherjs/blob/master/doc/syscalls.md). | |||
| System calls (file system access, etc.) will work only supported `GOOS` platforms (see above). See [doc/syscalls.md](https://github.com/gopherjs/gopherjs/blob/master/doc/syscalls.md) for instructions. | |||
There was a problem hiding this comment.
Thanks for spotting that, it was missing a word. I still wasn't happy with it, so I rewrote it completely in order to improve clarity. I think the new version is better.
Previous sentence was missing a word, and didn't sound great.
neelance
approved these changes
Mar 17, 2018
|
Thanks for reviewing! |
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.
Add instructions for what people should do when building with GopherJS on unsupported platforms. Code generation works completely fine, but syscalls (e.g., for
gopherjs run) will only work on supported platforms.Previously, this information was only in issues, people's heads, commit messages, etc. It should be documented in README to provide clarity.
Rename "OS X" to "macOS", the current name of that operating system. Rearrange sections to place more relevant information first. Mention Linux before macOS consistently. Linux is placed first because it's open source and more freely available than the proprietary macOS, so it's easier to recommend it as an alternative.
Resolves #770.
Updates #776.
Updates #688.