Skip to content

BUILDING.md: how-to-install has become obscured #25458

@tshinnic

Description

@tshinnic

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]

Metadata

Metadata

Assignees

No one assigned

    Labels

    buildIssues and PRs related to build files or the CI.docIssues and PRs related to the documentations.help wantedIssues that need assistance from volunteers or PRs that need help to proceed.installIssues and PRs related to the installers.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions