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.

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

doc: update to add ref to supported platforms #12931

Closed
wants to merge 2 commits into
base: master
from

Conversation

@mhdawson
Member

mhdawson commented May 9, 2017

Update README.md to be consistent with changes made
to earlier branches.

Was going to cover in #11942 but that PR
seemed stalled and may never land so doing it here so that I don't forget.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows [commit guidelines]
Affected core subsystem(s)

doc

doc: update to add ref to supported platforms
Update README.md to be consistent with changes made
to earlier branches.

@mhdawson mhdawson self-assigned this May 9, 2017

@cjihrig

cjihrig approved these changes May 9, 2017

@jasnell

jasnell approved these changes May 9, 2017

@refack

refack approved these changes May 9, 2017

Show outdated Hide outdated README.md
@@ -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.

This comment has been minimized.

@Trott

Trott May 10, 2017

Member

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.

@Trott

Trott May 10, 2017

Member

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.

This comment has been minimized.

@Trott

Trott May 10, 2017

Member

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
@Trott

Trott May 10, 2017

Member

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
@lpinca

lpinca approved these changes May 10, 2017

@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

mhdawson May 10, 2017

Member

@Trott, updated to break into 2 sentences.

Member

mhdawson commented May 10, 2017

@Trott, updated to break into 2 sentences.

@refack

refack approved these changes May 10, 2017

@targos

targos approved these changes May 10, 2017

@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

mhdawson May 11, 2017

Member

CI good, landing

Member

mhdawson commented May 11, 2017

CI good, landing

@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

mhdawson May 11, 2017

Member

landed as c79deaa

Member

mhdawson commented May 11, 2017

landed as c79deaa

@mhdawson mhdawson closed this May 11, 2017

mhdawson added a commit that referenced this pull request May 11, 2017

doc: update to add ref to supported platforms
Update README.md to be consistent with changes made
to earlier branches.

PR-URL: #12931
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: MichaëZasso <targos@protonmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

anchnk added a commit to anchnk/node that referenced this pull request May 19, 2017

doc: update to add ref to supported platforms
Update README.md to be consistent with changes made
to earlier branches.

PR-URL: nodejs#12931
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: MichaëZasso <targos@protonmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

@jasnell jasnell referenced this pull request May 28, 2017

Closed

8.0.0 Release Proposal #12220

@gibfahn gibfahn referenced this pull request Jun 15, 2017

Closed

Auditing for 6.11.1 #230

2 of 3 tasks complete

@mhdawson mhdawson deleted the mhdawson:building-ref branch Jun 28, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment