Skip to content

Commit 8de403d

Browse files
author
Machiste Quintana
committed
Finish Atom Shell -> Electron
1 parent f9bdded commit 8de403d

File tree

3 files changed

+36
-36
lines changed

3 files changed

+36
-36
lines changed

guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Learning NodeGit
1111
1212
- [Basics](install/)
1313
- [From source](install/from-source)
14-
- [Atom Shell](install/atom-shell/)
14+
- [Electron](install/electron/)
1515
- [NW.js](install/nw.js/)
1616

1717
***

guides/install/atom-shell/index.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

guides/install/electron/index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: full
3+
menu_item: guides
4+
title: Electron
5+
description: How to install NodeGit with Electron
6+
---
7+
8+
[Return to all guides](../../)
9+
10+
* * *
11+
12+
Install for Electron
13+
----------------------
14+
15+
For an application that is built using [Electron](https://github.com/atom/Electron) you'll need to have the `engines.electron` set to the version of Electron that you are targeting in your root `package.json` file.
16+
17+
For example if you have an Electron app that's targeting version 0.20.7 your package.json file would look something like:
18+
19+
```json
20+
{
21+
"name": "elec-app",
22+
"displayName": "My Electron app",
23+
"version": "0.0.1",
24+
"description": "",
25+
"main": "main.js",
26+
"author": "",
27+
"engines": {
28+
"electron": "0.20.7"
29+
}
30+
}
31+
```
32+
33+
And when doing an `npm install` or `apm install` inside of your Electron's root folder it will compile NodeGit targeting that version of Electron during the install.
34+
35+
*NOTE: there are no pre-built binaries for Electron, you must rebuild NodeGit. Visit our [building guides](../from-source) for help*

0 commit comments

Comments
 (0)