electron/node-gyp
1
0
Fork 0
mirror of https://github.com/electron/node-gyp.git synced 2025-09-15 13:43:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: updated README.md to copy easily (#2281)

Browse source 
PR-URL: https://github.com/nodejs/node-gyp/pull/2281
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
This commit is contained in:
மனோஜ்குமார் பழனிச்சாமி 2020-12-19 18:53:43 +05:30 • committed by GitHub
parent 15a5c7d45b
commit 6287118fc4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -23,7 +23,7 @@ etc.), regardless of what version of Node.js is actually installed on your syste
You can install `node-gyp` using `npm`: You can install `node-gyp` using `npm`:
``` bash ``` bash
$ npm install -g node-gyp npm install -g node-gyp
``` ```
Depending on your operating system, you will need to install: Depending on your operating system, you will need to install:
@ -71,7 +71,7 @@ version `node-gyp` should use in one of the following ways:
1. by setting the `--python` command-line option, e.g.: 1. by setting the `--python` command-line option, e.g.:
``` bash ``` bash
$ node-gyp <command> --python /path/to/executable/python node-gyp <command> --python /path/to/executable/python
``` ```
2. If `node-gyp` is called by way of `npm`, *and* you have multiple versions of 2. If `node-gyp` is called by way of `npm`, *and* you have multiple versions of
@ -79,7 +79,7 @@ Python installed, then you can set `npm`'s 'python' config key to the appropriat
value: value:
``` bash ``` bash
$ npm config set python /path/to/executable/python npm config set python /path/to/executable/python
``` ```
3. If the `PYTHON` environment variable is set to the path of a Python executable, 3. If the `PYTHON` environment variable is set to the path of a Python executable,
@ -95,20 +95,20 @@ searching will be done.
To compile your native addon, first go to its root directory: To compile your native addon, first go to its root directory:
``` bash ``` bash
$ cd my_node_addon cd my_node_addon
``` ```
The next step is to generate the appropriate project build files for the current The next step is to generate the appropriate project build files for the current
platform. Use `configure` for that: platform. Use `configure` for that:
``` bash ``` bash
$ node-gyp configure node-gyp configure
``` ```
Auto-detection fails for Visual C++ Build Tools 2015, so `--msvs_version=2015` Auto-detection fails for Visual C++ Build Tools 2015, so `--msvs_version=2015`
needs to be added (not needed when run by npm as configured above): needs to be added (not needed when run by npm as configured above):
``` bash ``` bash
$ node-gyp configure --msvs_version=2015 node-gyp configure --msvs_version=2015
``` ```
__Note__: The `configure` step looks for a `binding.gyp` file in the current __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
(on Windows) in the `build/` directory. Next, invoke the `build` command: (on Windows) in the `build/` directory. Next, invoke the `build` command:
``` bash ``` bash
$ node-gyp build node-gyp build
``` ```
Now you have your compiled `.node` bindings file! The compiled bindings end up 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:
Run this on Unix: Run this on Unix:
```bash ```bash
$ export npm_config_devdir=/tmp/.gyp export npm_config_devdir=/tmp/.gyp
``` ```
Or this on Windows: Or this on Windows:
```console ```console
> set npm_config_devdir=c:\temp\.gyp set npm_config_devdir=c:\temp\.gyp
``` ```
### `npm` configuration ### `npm` configuration
@ -230,7 +230,7 @@ Use the form `OPTION_NAME` for any of the command options listed above.
For example, to set `devdir` equal to `/tmp/.gyp`, you would run: For example, to set `devdir` equal to `/tmp/.gyp`, you would run:
```bash ```bash
$ npm config set [--global] devdir /tmp/.gyp npm config set [--global] devdir /tmp/.gyp
``` ```
**Note:** Configuration set via `npm` will only be used when `node-gyp` **Note:** Configuration set via `npm` will only be used when `node-gyp`