File tree Expand file tree Collapse file tree 1 file changed +20
-3
lines changed Expand file tree Collapse file tree 1 file changed +20
-3
lines changed Original file line number Diff line number Diff line change @@ -94,7 +94,7 @@ Depending on host platform, the selection of toolchains may vary.
9494
9595### Unix/macOS
9696
97- Prerequisites:
97+ #### Prerequisites
9898
9999* ` gcc ` and ` g++ ` 4.9.4 or newer, or
100100* ` clang ` and ` clang++ ` 3.4.2 or newer (macOS: latest Xcode Command Line Tools)
@@ -120,6 +120,8 @@ directory and the symbolic `node` link in the project's root directory.
120120On FreeBSD and OpenBSD, you may also need:
121121* libexecinfo
122122
123+ #### Building Node.js
124+
123125To build Node.js:
124126
125127``` console
@@ -138,13 +140,26 @@ for more information.
138140Note that the above requires that ` python ` resolve to Python 2.6 or 2.7
139141and not a newer version.
140142
141- To run the tests:
143+ #### Running Tests
144+
145+ To verify the build:
146+
147+ ``` console
148+ $ make test-only
149+ ```
150+
151+ At this point, you are ready to make code changes and re-run the tests.
152+
153+ If you are running tests prior to submitting a Pull Request, the recommended
154+ command is:
142155
143156``` console
144157$ make test
145158```
146159
147- At this point you are ready to make code changes and re-run the tests!
160+ ` make test ` does a full check on the codebase, including running linters and
161+ documentation tests.
162+
148163Optionally, continue below.
149164
150165To run the tests and generate code coverage reports:
@@ -166,6 +181,8 @@ reports:
166181$ make coverage-clean
167182```
168183
184+ #### Building the documentation
185+
169186To build the documentation:
170187
171188This will build Node.js first (if necessary) and then use it to build the docs:
You can’t perform that action at this time.
0 commit comments