docs: Don't mention apm
authorCheng Zhao <zcbenz@gmail.com>
Sun, 12 Apr 2015 13:46:50 +0000 (21:46 +0800)
committerCheng Zhao <zcbenz@gmail.com>
Sun, 12 Apr 2015 13:46:50 +0000 (21:46 +0800)
It causes confusions, and it is not convineint any more, see #793.

docs/tutorial/using-native-node-modules.md

index 8c72a7f..fa70c37 100644 (file)
@@ -1,33 +1,8 @@
 # Using native Node modules
 
 The native Node modules are supported by atom-shell, but since atom-shell is
-using a different V8 version from official Node, you need to use `apm` instead
-of `npm` to install Node modules.
-
-The usage of [apm](https://github.com/atom/apm) is quite similar to `npm`, to
-install dependencies from `package.json` of current project, just do:
-
-```bash
-$ cd /path/to/atom-shell/project/
-$ apm install .
-```
-
-But you should notice that `apm install module` won't work because it will
-install a user package for [Atom Editor](https://github.com/atom/atom) instead.
-
-## Which version of apm to use
-
-Generally using the latest release of `apm` for latest atom-shell always works,
-but if you are uncertain of the which version of `apm` to use, you may manually
-instruct `apm` to use headers of a specified version of atom-shell by setting
-the `ATOM_NODE_VERSION` environment.
-
-For example force installing modules for atom-shell v0.16.0:
-
-```bash
-$ export ATOM_NODE_VERSION=0.16.0
-$ apm install .
-```
+using a different V8 version from official Node, you have to manually specify
+the location of atom-shell's headers when building native modules.
 
 ## Native Node module compatibility
 
@@ -41,10 +16,7 @@ To solve this, you should use modules that support Node v0.11.x,
 For old modules that only support Node v0.10.x, you should use the
 [nan](https://github.com/rvagg/nan) module to port it to v0.11.x.
 
-## Other ways of installing native modules
-
-Apart from `apm`, you can also use `node-gyp` and `npm` to manually build the
-native modules.
+## How to install native modules
 
 ### The node-gyp way
 
@@ -63,9 +35,12 @@ where to download the headers. The `--arch=ia32` says the module is built for
 
 ### The npm way
 
+You can also use `npm` to install modules, the steps are exactly the same with
+Node modules, except that you need to setup some environment variables:
+
 ```bash
 export npm_config_disturl=https://atom.io/download/atom-shell
-export npm_config_target=0.6.0
-export npm_config_arch=ia32
+export npm_config_target=0.23.0
+export npm_config_arch=x64
 HOME=~/.atom-shell-gyp npm install module-name
 ```