Repository navigation
BUILDING.md: how-to-install has become obscured #25458
Description
The procedure to build and then install node has become obscured through changes
to BUILDING.md over the last two years. Much additional information has been added for
running tests, coverage, build docs, etc. and now important steps such as
$ [sudo] make install
are 4 pages down from the starting $ ./configure step, and is tacked on the end of
"Building the documentation"! How is someone unfamiliar with the "usual steps"
supposed to find "how to install node" ?
Simplest fix would be to emulate all the new section headings and add an "Installing
Node" section header before the four lines beginning "To test if Node.js was built
correctly:" I somehow feel the new section should be before subjects docs, coverage,
and maybe before even tests, given how much those have been elaborated on.
[doc]
Activity
mhdawson commentedon Jan 17, 2019
I tend to agree. Do @tshinnic do you want to file a PR. I think it might make sense to add the "Installing Node" section right after the "Building Node.js" section with a comment that if all you want to do after building is to use Node.js then these are the install steps. If you want to test etc. then the following paragraphs will help you with that.
PoojaDurgad commentedon Nov 23, 2020
fixed!!! #35710