| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
6 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -11,7 +11,7 @@ description: Learning NodeGit | |||
| 11 | 11 | ||
| 12 | 12 | - [Basics](install/) | |
| 13 | 13 | - [From source](install/from-source) | |
| 14 | - - [Atom Shell](install/atom-shell/) | ||
| 14 | + - [Electron](install/electron/) | ||
| 15 | 15 | - [NW.js](install/nw.js/) | |
| 16 | 16 | ||
| 17 | 17 | *** | |
| Original file line number | Diff line number | Diff 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* | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -23,11 +23,11 @@ npm install nodegit | |||
| 23 | 23 | <h3>Native Shells</h3> | |
| 24 | 24 | <div class="columns"> | |
| 25 | 25 | <div class="column"> | |
| 26 | - <a href="http://github.com/atom/atom-shell"> | ||
| 27 | - <img src="/img/atom.png"/> | ||
| 26 | + <a href="http://github.com/atom/electron"> | ||
| 27 | + <img src="/img/electron.svg"/> | ||
| 28 | 28 | </a> | |
| 29 | - <a href="/guides/install/atom-shell/"> | ||
| 30 | - Atom | ||
| 29 | + <a href="/guides/install/electron/"> | ||
| 30 | + Electron | ||
| 31 | 31 | </a> | |
| 32 | 32 | </div> | |
| 33 | 33 | <div class="column"> | |
| Back | FazBrowse Home | New Git URL |
0 commit comments