File tree 1 file changed +20
-3
lines changed
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.
94
94
95
95
### Unix/macOS
96
96
97
- Prerequisites:
97
+ #### Prerequisites
98
98
99
99
* ` gcc ` and ` g++ ` 4.9.4 or newer, or
100
100
* ` 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.
120
120
On FreeBSD and OpenBSD, you may also need:
121
121
* libexecinfo
122
122
123
+ #### Building Node.js
124
+
123
125
To build Node.js:
124
126
125
127
``` console
@@ -138,13 +140,26 @@ for more information.
138
140
Note that the above requires that ` python ` resolve to Python 2.6 or 2.7
139
141
and not a newer version.
140
142
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:
142
155
143
156
``` console
144
157
$ make test
145
158
```
146
159
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
+
148
163
Optionally, continue below.
149
164
150
165
To run the tests and generate code coverage reports:
@@ -166,6 +181,8 @@ reports:
166
181
$ make coverage-clean
167
182
```
168
183
184
+ #### Building the documentation
185
+
169
186
To build the documentation:
170
187
171
188
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