mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Merge pull request #1575 from atom/electron-rebuild-notes

Browse source 
Suggest electron-rebuild for building native modules
This commit is contained in:
Cheng Zhao 2015-05-05 15:10:18 +08:00
commit 57e6b75871
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/tutorial/using-native-node-modules.md
View file

@ -18,6 +18,19 @@ For old modules that only support Node v0.10.x, you should use the
## How to install native modules
### The Easy Way
The most straightforward way to rebuild native modules is via the
[`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) package,
which handles the manual steps of downloading headers and building native modules:
```sh
npm install --save-dev electron-rebuild
# Every time you run npm install, run this too
./node_modules/.bin/electron-rebuild
```
### The node-gyp way
To build Node modules with headers of Electron, you need to tell `node-gyp`