From 0d8994d81daa908e598fb8baf6d6cf3a558fceb0 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 16 Mar 2016 09:37:04 -0700 Subject: [PATCH 1/5] improve wording in the FAQ --- docs/faq/electron-faq.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/faq/electron-faq.md b/docs/faq/electron-faq.md index a58d31107b6d..ef08de5237f0 100644 --- a/docs/faq/electron-faq.md +++ b/docs/faq/electron-faq.md @@ -5,7 +5,7 @@ The Chrome version of Electron is usually bumped within one or two weeks after a new stable Chrome version gets released. -Also we only use stable channel of Chrome, if an important fix is in beta or dev +Also we only use stable channel of Chrome. If an important fix is in beta or dev channel, we will back-port it. ## When will Electron upgrade to latest Node.js? @@ -25,7 +25,7 @@ use HTML5 APIs which are already available in browsers. Good candidates are [Storage API][storage], [`localStorage`][local-storage], [`sessionStorage`][session-storage], and [IndexedDB][indexed-db]. -Or you can use the IPC system, which are specific to Electron, to store objects +Or you can use the IPC system, which is specific to Electron, to store objects in the main process as a global variable, and then to access them from the renderers through the `remote` module: @@ -51,8 +51,7 @@ console.log(require('remote').getGlobal('sharedObject').someProperty); This happens when the variable which is used to store the window/tray gets garbage collected. -It is recommended to have a reading of following articles you encountered this -problem: +If you encounter this problem, the following articles may prove helpful: * [Memory Management][memory-management] * [Variable Scope][variable-scope] @@ -78,8 +77,8 @@ app.on('ready', function() { ## I can not use jQuery/RequireJS/Meteor/AngularJS in Electron. Due to the Node.js integration of Electron, there are some extra symbols -inserted into DOM, like `module`, `exports`, `require`. This causes troubles for -some libraries since they want to insert the symbols with same names. +inserted into the DOM like `module`, `exports`, `require`. This causes troubles for +some libraries since they want to insert the symbols with the same names. To solve this, you can turn off node integration in Electron: @@ -141,7 +140,7 @@ npm uninstall -g electron ``` However if your are using the built-in module but still getting this error, it -is very likely you are using the module in wrong process. For example +is very likely you are using the module in the wrong process. For example `electron.app` can only be used in the main process, while `electron.webFrame` is only available in renderer processes. From da47b569e8e31a2e19bc7723818a92f8fec23908 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 16 Mar 2016 09:42:33 -0700 Subject: [PATCH 2/5] link to the ninja website --- docs/development/build-instructions-osx.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/build-instructions-osx.md b/docs/development/build-instructions-osx.md index ac51bf0dc224..598aa01c4406 100644 --- a/docs/development/build-instructions-osx.md +++ b/docs/development/build-instructions-osx.md @@ -22,7 +22,7 @@ $ git clone https://github.com/atom/electron.git ## Bootstrapping The bootstrap script will download all necessary build dependencies and create -the build project files. Notice that we're using `ninja` to build Electron so +the build project files. Notice that we're using [ninja](https://ninja-build.org/) to build Electron so there is no Xcode project generated. ```bash From 6503f32ef9b89fde1798a8ac94bf318c0606e1ed Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 16 Mar 2016 09:47:12 -0700 Subject: [PATCH 3/5] add another link to ninja --- docs/development/build-system-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/build-system-overview.md b/docs/development/build-system-overview.md index 04067ce8c79c..41c65e450a42 100644 --- a/docs/development/build-system-overview.md +++ b/docs/development/build-system-overview.md @@ -1,6 +1,6 @@ # Build System Overview -Electron uses `gyp` for project generation and `ninja` for building. Project +Electron uses `gyp` for project generation and [ninja](https://ninja-build.org/) for building. Project configurations can be found in the `.gyp` and `.gypi` files. ## Gyp Files From 5acfa8611af9fe2878d774ae2cf91d5931cc820b Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 16 Mar 2016 13:15:34 -0700 Subject: [PATCH 4/5] link to gyp --- docs/development/build-system-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/build-system-overview.md b/docs/development/build-system-overview.md index 41c65e450a42..61b88e14078c 100644 --- a/docs/development/build-system-overview.md +++ b/docs/development/build-system-overview.md @@ -1,6 +1,6 @@ # Build System Overview -Electron uses `gyp` for project generation and [ninja](https://ninja-build.org/) for building. Project +Electron uses [gyp](https://gyp.gsrc.io/) for project generation and [ninja](https://ninja-build.org/) for building. Project configurations can be found in the `.gyp` and `.gypi` files. ## Gyp Files From 01980dea11bf66b0275eccf974f5d638438ee438 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Thu, 17 Mar 2016 00:03:24 -0700 Subject: [PATCH 5/5] s/troubles/problems/ --- docs/faq/electron-faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq/electron-faq.md b/docs/faq/electron-faq.md index ef08de5237f0..41b301d71981 100644 --- a/docs/faq/electron-faq.md +++ b/docs/faq/electron-faq.md @@ -77,7 +77,7 @@ app.on('ready', function() { ## I can not use jQuery/RequireJS/Meteor/AngularJS in Electron. Due to the Node.js integration of Electron, there are some extra symbols -inserted into the DOM like `module`, `exports`, `require`. This causes troubles for +inserted into the DOM like `module`, `exports`, `require`. This causes problems for some libraries since they want to insert the symbols with the same names. To solve this, you can turn off node integration in Electron: