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 @@ -95,7 +95,7 @@ Depending on host platform, the selection of toolchains may vary.
95
95
96
96
### Unix / macOS
97
97
98
- Prerequisites:
98
+ #### Prerequisites
99
99
100
100
* ` gcc ` and ` g++ ` 4.9.4 or newer, or
101
101
* ` clang ` and ` clang++ ` 3.4.2 or newer (macOS: latest Xcode Command Line Tools)
@@ -121,6 +121,8 @@ directory and the symbolic `node` link in the project's root directory.
121
121
On FreeBSD and OpenBSD, you may also need:
122
122
* libexecinfo
123
123
124
+ #### Building Node.js
125
+
124
126
To build Node.js:
125
127
126
128
``` console
@@ -139,13 +141,26 @@ for more information.
139
141
Note that the above requires that ` python ` resolve to Python 2.6 or 2.7
140
142
and not a newer version.
141
143
142
- To run the tests:
144
+ #### Running Tests
145
+
146
+ To verify the build:
147
+
148
+ ``` console
149
+ $ make test-only
150
+ ```
151
+
152
+ At this point, you are ready to make code changes and re-run the tests.
153
+
154
+ If you are running tests prior to submitting a Pull Request, the recommended
155
+ command is:
143
156
144
157
``` console
145
158
$ make test
146
159
```
147
160
148
- At this point you are ready to make code changes and re-run the tests!
161
+ ` make test ` does a full check on the codebase, including running linters and
162
+ documentation tests.
163
+
149
164
Optionally, continue below.
150
165
151
166
To run the tests and generate code coverage reports:
@@ -167,6 +182,8 @@ reports:
167
182
$ make coverage-clean
168
183
```
169
184
185
+ #### Building the documentation
186
+
170
187
To build the documentation:
171
188
172
189
This 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