mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Merge pull request #4831 from atom/docs-cleanup

Browse source 
[WIP] Docs cleanup
This commit is contained in:
Cheng Zhao 2016-03-21 20:57:26 +09:00
commit 43cb48295b
3 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/development/build-instructions-osx.md
View file

@ -22,7 +22,7 @@ $ git clone https://github.com/atom/electron.git
## Bootstrapping ## Bootstrapping
The bootstrap script will download all necessary build dependencies and create 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. there is no Xcode project generated.
```bash ```bash

2
docs/development/build-system-overview.md
View file

@ -1,6 +1,6 @@
# Build System Overview # Build System Overview
Electron uses `gyp` for project generation and `ninja` 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. configurations can be found in the `.gyp` and `.gypi` files.
## Gyp Files ## Gyp Files

13
docs/faq/electron-faq.md
View file

@ -5,7 +5,7 @@
The Chrome version of Electron is usually bumped within one or two weeks after The Chrome version of Electron is usually bumped within one or two weeks after
a new stable Chrome version gets released. 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. channel, we will back-port it.
## When will Electron upgrade to latest Node.js? ## 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], [Storage API][storage], [`localStorage`][local-storage],
[`sessionStorage`][session-storage], and [IndexedDB][indexed-db]. [`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 in the main process as a global variable, and then to access them from the
renderers through the `remote` module: 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 This happens when the variable which is used to store the window/tray gets
garbage collected. garbage collected.
It is recommended to have a reading of following articles you encountered this If you encounter this problem, the following articles may prove helpful:
problem:
* [Memory Management][memory-management] * [Memory Management][memory-management]
* [Variable Scope][variable-scope] * [Variable Scope][variable-scope]
@ -78,8 +77,8 @@ app.on('ready', function() {
## I can not use jQuery/RequireJS/Meteor/AngularJS in Electron. ## I can not use jQuery/RequireJS/Meteor/AngularJS in Electron.
Due to the Node.js integration of Electron, there are some extra symbols Due to the Node.js integration of Electron, there are some extra symbols
inserted into 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 same names. some libraries since they want to insert the symbols with the same names.
To solve this, you can turn off node integration in Electron: 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 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` `electron.app` can only be used in the main process, while `electron.webFrame`
is only available in renderer processes. is only available in renderer processes.