Skip to content

doc: update to add ref to supported platforms #12931

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

doc: update to add ref to supported platforms #12931

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a82afee
doc: update to add ref to supported platforms
mhdawson May 9, 2017
4c72bc4
squash: address comments
mhdawson May 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ the binary verification command above.
## Building Node.js

See [BUILDING.md](BUILDING.md) for instructions on how to build
Node.js from source.
Node.js from source along with a list of officially supported platforms.
Copy link
Member

@Trott Trott May 10, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Nit: Maybe put a comma after source so that it's clearer that it's "how to build from source" and "a list of officially supported platforms" rather than "how to build from source" and "how to build a list of officially supported platforms"?

Although I'm not sure that adding the comma doesn't then risk interpretation as "how to build Node.js from source, as long as you also have the list of officially supported platforms because you need that to build from source." :-D

Maybe the best thing is to split it into two sentences?:

See BUILDING.md for instructions on how to build Node.js from source. The document also contains a list of officially supported platforms.

Copy link
Member

Choose a reason for hiding this comment

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

Another options just to make sure I give TOO MANY CHOICES:

See [BUILDING.md](BUILDING.md) for:

* instructions on how to build Node.js from source
* a list of officially supported platforms


## Security

Expand Down