Skip to content

Commit f31ddcb

Browse files
author
John Haley
committed
Add guides for atom-shell and nw.js installation
1 parent 632a16f commit f31ddcb

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

guides/install/atom-shell/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,28 @@ description: How to install NodeGit with Atom Shell
88
[Return to install guides](../)
99

1010
* * *
11+
12+
Install for atom-shell
13+
----------------------
14+
15+
For an application that is built using [atom-shell](https://github.com/atom/atom-shell) you'll need to have the `engines.atom-shell` set to the version of atom-shell that you are targeting in your root `package.json` file.
16+
17+
For example if you have an atom-shell app that's targeting version 0.20.7 your package.json file would look something like
18+
19+
```json
20+
{
21+
"name": "as-app",
22+
"displayName": "My Atom Shell app",
23+
"version": "0.0.1",
24+
"description": "",
25+
"main": "main.js",
26+
"author": "",
27+
"engines": {
28+
"atom-shell": "0.20.7"
29+
}
30+
}
31+
```
32+
33+
And when doing an `npm install` or `apm install` inside of your atom-shell's root folder it will compile NodeGit targeting that version of atom-shell during the install.
34+
35+
*NOTE: there are no pre-built binaries for atom-shell, you must rebuild NodeGit. Visit our [building guides](../from-source) for help*

guides/install/nw.js/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,26 @@ description: How to install NodeGit with NW.js
88
[Return to install guides](../)
99

1010
* * *
11+
12+
Install for nwjs
13+
----------------
14+
15+
For an application that is built using [NW.js](https://github.com/nwjs/nw.js) you'll need to have the `engines['nw.js']` set to the version of NW.js that you are targeting in your root `package.json` file.
16+
17+
For example if you have an NS.js app that's targeting version 0.12.0 your package.json file would look something like
18+
19+
```json
20+
{
21+
"name": "nw-app",
22+
"displayName": "My NW.js app",
23+
"version": "0.0.1",
24+
"description": "",
25+
"engines": {
26+
"nw.js": "0.12.0"
27+
}
28+
}
29+
```
30+
31+
And when doing an `npm install` inside of your NW.js app's root folder it will compile NodeGit targeting that version of NW.js during the install.
32+
33+
*NOTE: there are no pre-built binaries for NW.js, you must rebuild NodeGit. Visit our [building guides](../from-source) for help*

0 commit comments

Comments
 (0)