You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Continuing what a58b48b did for the
doc/ dir, this fixes some formatting issues in the *.md files that
are placed directly in the top-level directory.
README.md changes are excluded as they are covered by
#7971
Refs: #7637
PR-URL: #7727
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Copy file name to clipboardExpand all lines: BUILDING.md
+27-23Lines changed: 27 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ On FreeBSD and OpenBSD, you may also need:
28
28
* libexecinfo (FreeBSD and OpenBSD only)
29
29
30
30
31
-
```text
31
+
```console
32
32
$ ./configure
33
33
$ make
34
34
$ [sudo] make install
@@ -37,7 +37,7 @@ $ [sudo] make install
37
37
If your Python binary is in a non-standard location or has a
38
38
non-standard name, run the following instead:
39
39
40
-
```text
40
+
```console
41
41
$ export PYTHON=/path/to/python
42
42
$ $PYTHON ./configure
43
43
$ make
@@ -46,13 +46,13 @@ $ [sudo] make install
46
46
47
47
To run the tests:
48
48
49
-
```text
49
+
```console
50
50
$ make test
51
51
```
52
52
53
53
To run the native module tests:
54
54
55
-
```text
55
+
```console
56
56
$ make test-addons
57
57
```
58
58
@@ -61,35 +61,35 @@ To run the npm test suite:
61
61
*note: to run the suite on node v4 or earlier you must first*
62
62
*run `make install`*
63
63
64
-
```
64
+
```console
65
65
$ make test-npm
66
66
```
67
67
68
68
To build the documentation:
69
69
70
70
This will build Node.js first (if necessary) and then use it to build the docs:
71
71
72
-
```text
72
+
```console
73
73
$ make doc
74
74
```
75
75
76
76
If you have an existing Node.js you can build just the docs with:
77
77
78
-
```text
78
+
```console
79
79
$ NODE=node make doc-only
80
80
```
81
81
82
82
(Where `node` is the path to your executable.)
83
83
84
84
To read the documentation:
85
85
86
-
```text
86
+
```console
87
87
$ man doc/node.1
88
88
```
89
89
90
90
To test if Node.js was built correctly:
91
91
92
-
```
92
+
```console
93
93
$ node -e "console.log('Hello from Node.js ' + process.version)"
94
94
```
95
95
@@ -107,19 +107,19 @@ Prerequisites:
107
107
[Git for Windows](http://git-scm.com/download/win) includes Git Bash
108
108
and tools which can be included in the global `PATH`.
109
109
110
-
```text
110
+
```console
111
111
> vcbuild nosign
112
112
```
113
113
114
114
To run the tests:
115
115
116
-
```text
116
+
```console
117
117
> vcbuild test
118
118
```
119
119
120
120
To test if Node.js was built correctly:
121
121
122
-
```text
122
+
```console
123
123
> Release\node -e "console.log('Hello from Node.js', process.version)"
124
124
```
125
125
@@ -136,7 +136,7 @@ Be sure you have downloaded and extracted [Android NDK]
0 commit comments