doc: update to add ref to supported platforms #12931
Conversation
Update README.md to be consistent with changes made to earlier branches.
README.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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, updated to break into 2 sentences. |
|
CI good, landing |
|
landed as c79deaa |
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>
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>
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), orvcbuild test(Windows) passesAffected core subsystem(s)
doc