Skip to content

Commit 8e10b15

Browse files
SmartManojowl-from-hogvarts
authored andcommitted
doc: updated README.md to copy easily (nodejs#2281)
PR-URL: nodejs#2281 Reviewed-By: Jiawen Geng <[email protected]>
1 parent fcdb890 commit 8e10b15

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ etc.), regardless of what version of Node.js is actually installed on your syste
2323
You can install `node-gyp` using `npm`:
2424

2525
``` bash
26-
$ npm install -g node-gyp
26+
npm install -g node-gyp
2727
```
2828

2929
Depending on your operating system, you will need to install:
@@ -71,15 +71,15 @@ version `node-gyp` should use in one of the following ways:
7171
1. by setting the `--python` command-line option, e.g.:
7272

7373
``` bash
74-
$ node-gyp <command> --python /path/to/executable/python
74+
node-gyp <command> --python /path/to/executable/python
7575
```
7676

7777
2. If `node-gyp` is called by way of `npm`, *and* you have multiple versions of
7878
Python installed, then you can set `npm`'s 'python' config key to the appropriate
7979
value:
8080

8181
``` bash
82-
$ npm config set python /path/to/executable/python
82+
npm config set python /path/to/executable/python
8383
```
8484

8585
3. If the `PYTHON` environment variable is set to the path of a Python executable,
@@ -95,20 +95,20 @@ searching will be done.
9595
To compile your native addon, first go to its root directory:
9696

9797
``` bash
98-
$ cd my_node_addon
98+
cd my_node_addon
9999
```
100100

101101
The next step is to generate the appropriate project build files for the current
102102
platform. Use `configure` for that:
103103

104104
``` bash
105-
$ node-gyp configure
105+
node-gyp configure
106106
```
107107

108108
Auto-detection fails for Visual C++ Build Tools 2015, so `--msvs_version=2015`
109109
needs to be added (not needed when run by npm as configured above):
110110
``` bash
111-
$ node-gyp configure --msvs_version=2015
111+
node-gyp configure --msvs_version=2015
112112
```
113113

114114
__Note__: The `configure` step looks for a `binding.gyp` file in the current
@@ -118,7 +118,7 @@ Now you will have either a `Makefile` (on Unix platforms) or a `vcxproj` file
118118
(on Windows) in the `build/` directory. Next, invoke the `build` command:
119119

120120
``` bash
121-
$ node-gyp build
121+
node-gyp build
122122
```
123123

124124
Now you have your compiled `.node` bindings file! The compiled bindings end up
@@ -214,13 +214,13 @@ For example, to set `devdir` equal to `/tmp/.gyp`, you would:
214214
Run this on Unix:
215215

216216
```bash
217-
$ export npm_config_devdir=/tmp/.gyp
217+
export npm_config_devdir=/tmp/.gyp
218218
```
219219

220220
Or this on Windows:
221221

222222
```console
223-
> set npm_config_devdir=c:\temp\.gyp
223+
set npm_config_devdir=c:\temp\.gyp
224224
```
225225

226226
### `npm` configuration
@@ -230,7 +230,7 @@ Use the form `OPTION_NAME` for any of the command options listed above.
230230
For example, to set `devdir` equal to `/tmp/.gyp`, you would run:
231231

232232
```bash
233-
$ npm config set [--global] devdir /tmp/.gyp
233+
npm config set [--global] devdir /tmp/.gyp
234234
```
235235

236236
**Note:** Configuration set via `npm` will only be used when `node-gyp`

0 commit comments

Comments
 (0)