Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 40a0ef3

Browse files
committed
Update docs/getting_started.md
1 parent e550cef commit 40a0ef3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/getting_started.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ When running `npm install` a post install script is also executed, which will `n
2121
2222
electron-vue uses a two package.json setup. Find out more [here](https://simulatedgreg.gitbooks.io/electron-vue/content/docs/project_structure.html).
2323

24+
#### On the subject of electron
25+
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).
26+
27+
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/).
28+
2429
#### A note for Windows Users
2530
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.
2631

@@ -29,8 +34,3 @@ The first item we need to check is our npm version and ensure that it is not out
2934
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.
3035

3136
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).
35-
36-
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/).

0 commit comments

Comments
 (0)