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

📝 Update docs on using native modules.

Browse source
This commit is contained in:
Cheng Zhao 2014-02-20 18:51:57 +08:00
parent 94b3de557e
commit 2b82eafff4
3 changed files with 16 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/README.md
View file

@ -3,7 +3,7 @@
## Guides ## Guides
* [Quick start](quick-start.md) * [Quick start](quick-start.md)
* [Build native modules](build-native-modules.md) * [Use native modules](use-native-modules.md)
## Development ## Development

2
docs/development/build-instructions-linux.md
View file

@ -54,7 +54,7 @@ Then you need to install `gcc-multilib` and `g++-multilib`, on Ubuntu you can do
this: this:
```bash ```bash
sudo apt-get install gcc-multilib g++-multilib $ sudo apt-get install gcc-multilib g++-multilib
``` ```
## Tests ## Tests

25
docs/build-native-modules.md → docs/use-native-modules.md
View file

@ -1,15 +1,24 @@
# Build native modules # Use native modules
Since atom-shell is using a different V8 version from the official node, you Since atom-shell is using a different V8 version from the official node, you
need to build native module against atom-shell's headers to use them. need to build native module against atom-shell's headers to use them.
You need to use node-gyp to compile native modules, you can install node-gyp The [apm](https://github.com/atom/apm) provided a easy way to do this, after
via npm if you hadn't: installing it you could use it to install dependencies just like using `npm`:
```bash ```bash
$ npm install -g node-gyp $ cd /path/to/atom-shell/project/
$ apm install .
``` ```
But you should notice that `apm install module` wont' work because it will
install a user package for [Atom](https://github.com/atom/atom) instead.
Apart from `apm`, you can also use `node-gyp` and `npm` to manually build the
native modules.
## The node-gyp way
First you need to check which node release atom-shell is carrying via First you need to check which node release atom-shell is carrying via
`process.version` (at the time of writing it is v0.10.5), then you can `process.version` (at the time of writing it is v0.10.5), then you can
configure and build native modules via following commands: configure and build native modules via following commands:
@ -23,13 +32,7 @@ The `HOME=~/.atom-shell-gyp` changes where to find development headers. The
`--target=0.10.5` is specifying node's version. The `--dist-url=...` specifies `--target=0.10.5` is specifying node's version. The `--dist-url=...` specifies
where to download the headers. where to download the headers.
## Use npm to build native modules ## The npm way
Under most circumstances you would want to use npm to install modules, if
you're using npm >= v1.2.19 (because [a
patch](https://github.com/TooTallNate/node-gyp/commit/afbcdea1ffd25c02bc88d119b10337852c44d400)
is needed to make `npm_config_disturl` work) you can use following code to
download and build native modules against atom-shell's headers:
```bash ```bash
export npm_config_disturl=https://gh-contractor-zcbenz.s3.amazonaws.com/atom-shell/dist export npm_config_disturl=https://gh-contractor-zcbenz.s3.amazonaws.com/atom-shell/dist