github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8178 from lgeiger/native-modules-prebuild

Browse Source 
Add instructions for native modules using prebuild
This commit is contained in:
Kevin Sawicki
2016-12-12 09:29:27 -08:00
committed by GitHub
parent 009c00cdc6 6bcf4b1112
commit a2d1a5258b
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/tutorial/using-native-node-modules.md
View File

@@ -76,6 +76,16 @@ following things:
* After you upgraded Electron, you usually need to rebuild the modules.
* When in doubt, run `electron-rebuild` first.
## Modules that rely on `prebuild`
[`prebuild`](https://github.com/mafintosh/prebuild) provides a way to easily
publish native Node modules with prebuilt binaries for multiple versions of Node
and Electron.
If modules provide binaries for the usage in Electron, make sure to omit
`--build-from-source` and the `npm_config_build_from_source` environment
variable in order to take full advantage of the prebuilt binaries.
## Modules that rely on `node-pre-gyp`
The [`node-pre-gyp` tool][node-pre-gyp] provides a way to deploy native Node