From fbbb25b901f46505c87931e6d661802a1b06f205 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 8 Oct 2018 09:24:37 -0700 Subject: [PATCH] doc: edit building-node text Simplifying some BUILDING.md and related text since a lot of people will be reading it soon for Code & Learn. I'd prefer to delete much of this text, but that risks controversy. These simplifications should be (I hope) uncontroversial. PR-URL: https://github.com/nodejs/node/pull/23335 Reviewed-By: Richard Lau Reviewed-By: Luigi Pinca Reviewed-By: Vse Mozhet Byt --- BUILDING.md | 8 ++++---- README.md | 5 ++--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 28524cb409efcd..839480eec38a88 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -1,10 +1,10 @@ # Building Node.js -Depending on what platform or features you require, the build process may -differ slightly. After you've successfully built a binary, running the -test suite to validate that the binary works as intended is a good next step. +Depending on what platform or features you need, the build process may +differ. After you've built a binary, running the +test suite to confirm that the binary works as intended is a good next step. -If you can reproduce a test failure consistently, search for it in the +If you can reproduce a test failure, search for it in the [Node.js issue tracker](https://github.com/nodejs/node/issues) or file a new issue. diff --git a/README.md b/README.md index 1192e6532c5470..aecf34d4023422 100644 --- a/README.md +++ b/README.md @@ -155,9 +155,8 @@ the file's signature. ## Building Node.js -See [BUILDING.md](BUILDING.md) for instructions on how to build -Node.js from source. The document also contains a list of -officially supported platforms. +See [BUILDING.md](BUILDING.md) for instructions on how to build Node.js from +source and a list of supported platforms. ## Security