Skip to content

Commit 0f418c8

Browse files
committed
[docs] update electron-packager ignore, add note about fixing electron version (SimulatedGREG#60) [skip ci]
1 parent b728f0d commit 0f418c8

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

docs/building_your_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ electron-vue makes use of [electron-packager](https://github.com/electron-userla
2222
icon: path.join(__dirname, '../app/icons/icon'),
2323

2424
// Ignore files that would bloat final build size
25-
ignore: /node_modules|src|index.ejs|icons/,
25+
ignore: /\b(node_modules|src|index\.ejs|icons)\b/,
2626

2727
// `config.js` name
2828
name: config.name,

docs/getting_started.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,14 @@ npm run dev
1616

1717
When running `npm install` a post install script is also executed, which will `npm install` inside the `app` directory as well.
1818

19-
2019
> Why is there another `package.json`?
2120
22-
electron-vue uses a two package.json setup. Find out more [here](https://simulatedgreg.gitbooks.io/electron-vue/content/docs/project_structure.html).
21+
electron-vue uses a **two `package.json`** setup. Find out more [here](https://simulatedgreg.gitbooks.io/electron-vue/content/docs/project_structure.html).
22+
23+
#### On the subject of electron
24+
electron-vue requires the use of electron `>= v1.2.3`. The `v1.2.3` release adds support for more [`chrome.*` APIs](https://github.com/electron/electron/releases/tag/v1.2.3) that `vue-devtools` depends upon. If you are needing a previous release of electron before `v1.2.3`, then you will need to manually uninstall [`electron-devtools-installer`](https://github.com/SimulatedGREG/electron-vue/blob/master/template/package.json#L36) from `./package.json` and revert `./app/electron.js` to a previous version found [here](https://github.com/SimulatedGREG/electron-vue/commit/e7175ee0337f3af36de49aef10cf58a64d75a220).
25+
26+
Although optional, it is recommended to lock in your electron version after scaffolding your project. This helps prevent other developers working on the same project developing on different versions. Electron makes releases quite often so features are always subject to change. [More Info](http://electron.atom.io/docs/tutorial/electron-versioning/).
2327

2428
#### A note for Windows Users
2529
If you run into errors during `npm install` about `node-gyp`, then you most likely do not have the proper build tools installed on your system. Build tools include items like Python and Visual Studio. Thanks to [@felixrieseberg](https://github.com/felixrieseberg), there are a few packages to help simplify this process.
@@ -29,6 +33,3 @@ The first item we need to check is our npm version and ensure that it is not out
2933
Once that is complete, we can then continue to setup the needed build tools. Using [`windows-build-tools`](https://github.com/felixrieseberg/windows-build-tools), most of the dirty work is done for us. Installing this globally will in turn setup Visual C++ packages, Python, and more.
3034

3135
At this point things should successfully install, but if not then you will need a clean installation of Visual Studio. Please note that these are not direct problems with electron-vue itself. (Windows can be difficult sometimes ¯\\\_(ツ)\_/¯)
32-
33-
#### On the subject of electron
34-
electron-vue requires the use of electron `>= v1.2.3`. The `v1.2.3` release adds support for more [`chrome.*` APIs](https://github.com/electron/electron/releases/tag/v1.2.3) that `vue-devtools` depends upon. If you are needing a previous release of electron before `v1.2.3`, then you will need to manually uninstall [`electron-devtools-installer`](https://github.com/SimulatedGREG/electron-vue/blob/master/template/package.json#L36) from `./package.json` and revert `./app/electron.js` to a previous version found [here](https://github.com/SimulatedGREG/electron-vue/commit/e7175ee0337f3af36de49aef10cf58a64d75a220).

docs/global_configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
electron-vue uses the [webpack](https://github.com/webpack/webpack) module loader system for pre-processing, bundling, and building your app. The default settings are rather common and should meet most of your needs. An additional `config.js` is provided in the root directory for quick adjustments. Further customization can be made by directly adjusting `webpack.config.js`.
44

5-
#### ``config.js``
5+
#### `config.js`
66
```js
77
{
88
// Name of electron app
@@ -23,7 +23,7 @@ electron-vue uses the [webpack](https://github.com/webpack/webpack) module loade
2323
asar: true,
2424
dir: path.join(__dirname, 'app'),
2525
icon: path.join(__dirname, 'app/icons/icon'),
26-
ignore: /node_modules|src|index.ejs|icons/,
26+
ignore: /\b(node_modules|src|index\.ejs|icons)\b/,
2727
name: pkg.name,
2828
out: path.join(__dirname, 'builds'),
2929
overwrite: true,

0 commit comments

Comments
 (0)