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

❤️ Feedback

Browse source
This commit is contained in:
Felix Rieseberg 2018-02-21 10:12:19 -08:00
parent 975e6e6194
commit 9d4c68d272
6 changed files with 36 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/README.md
View file

@ -52,11 +52,16 @@ an issue:
* [Spectron](tutorial/accessibility.md#spectron) * [Spectron](tutorial/accessibility.md#spectron)
* [Devtron](tutorial/accessibility.md#devtron) * [Devtron](tutorial/accessibility.md#devtron)
* [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility) * [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility)
* [Application Testing and Debugging](tutorial/application-debugging.md)
* [Debugging the Main Process](tutorial/debugging-main-process.md)
* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
* [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
* [DevTools Extension](tutorial/devtools-extension.md)
* [Application Distribution](tutorial/application-distribution.md) * [Application Distribution](tutorial/application-distribution.md)
* [Supported Platforms](tutorial/supported-platforms.md)
* [Mac App Store](tutorial/mac-app-store-submission-guide.md) * [Mac App Store](tutorial/mac-app-store-submission-guide.md)
* [Windows Store](tutorial/windows-store-guide.md) * [Windows Store](tutorial/windows-store-guide.md)
* [Snapcraft](tutorial/snapcraft.md) * [Snapcraft](tutorial/snapcraft.md)
* [Supported Platforms](tutorial/supported-platforms.md)
* [Application Security](tutorial/security.md) * [Application Security](tutorial/security.md)
* [Reporting Security Issues](tutorial/security.md#reporting-security-issues) * [Reporting Security Issues](tutorial/security.md#reporting-security-issues)
* [Chromium Security Issues and Upgrades](tutorial/security.md#chromium-security-issues-and-upgrades) * [Chromium Security Issues and Upgrades](tutorial/security.md#chromium-security-issues-and-upgrades)
@ -66,15 +71,10 @@ an issue:
* [Deploying an Update Server](tutorial/updates.md#deploying-an-update-server) * [Deploying an Update Server](tutorial/updates.md#deploying-an-update-server)
* [Implementing Updates in Your App](tutorial/updates.md#implementing-updates-in-your-app) * [Implementing Updates in Your App](tutorial/updates.md#implementing-updates-in-your-app)
* [Applying Updates](tutorial/updates.md#applying-updates) * [Applying Updates](tutorial/updates.md#applying-updates)
* [Application Debugging](tutorial/application-debugging.md)
* [Debugging the Main Process](tutorial/debugging-main-process.md)
* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
* [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
* [DevTools Extension](tutorial/devtools-extension.md)
## Detailed Tutorials ## Detailed Tutorials
These individual tutorial expand on topics discussed in the guide above. These individual tutorials expand on topics discussed in the guide above.
* [In Detail: Installing Electron](tutorial/installation.md) * [In Detail: Installing Electron](tutorial/installation.md)
* [Global versus Local Installation](tutorial/installation.md#global-versus-local-installation) * [Global versus Local Installation](tutorial/installation.md#global-versus-local-installation)

4
docs/tutorial/application-debugging.md
View file

@ -6,8 +6,8 @@ bottlenecks, or optimization opportunities.
## Renderer Process ## Renderer Process
The most comprehensive tool to debug individual renderer processes are the The most comprehensive tool to debug individual renderer processes is the
Chromium Developer Tools. They are available for all renderer processes, Chromium Developer Toolset. It is available for all renderer processes,
including instances of `BrowserWindow`, `BrowserView`, and `WebView`. You including instances of `BrowserWindow`, `BrowserView`, and `WebView`. You
can open them programmatically by calling the `openDevTools()` API on the can open them programmatically by calling the `openDevTools()` API on the
`webContents` of the instance: `webContents` of the instance:

4
docs/tutorial/boilerplates-and-clis.md
View file

@ -8,7 +8,7 @@ the app and build pipeline they need.
That level of modularity and extendability ensures that all developers working That level of modularity and extendability ensures that all developers working
with Electron, both big and small in team-size, are never restricted in what with Electron, both big and small in team-size, are never restricted in what
they can or cannot do at any time during their development life-cycle. However, they can or cannot do at any time during their development lifecycle. However,
for many developers, one of the community-driven boilerplates or command line for many developers, one of the community-driven boilerplates or command line
tools might make it dramatically easier to compile, package, and release an tools might make it dramatically easier to compile, package, and release an
app. app.
@ -42,7 +42,7 @@ You can find more information and documentation on [electronforge.io][forge].
A "complete solution to package and build a ready-for-distribution Electron app" A "complete solution to package and build a ready-for-distribution Electron app"
that focuses on an integrated experience. [`electron-builder`][builder] adds one that focuses on an integrated experience. [`electron-builder`][builder] adds one
single dependency focuses on simplicity and manages all further requirments single dependency focused on simplicity and manages all further requirements
internally. internally.
`electron-builder` replaces features and modules used by the Electron `electron-builder` replaces features and modules used by the Electron

13
docs/tutorial/development-environment.md
View file

@ -7,15 +7,18 @@ rudimentary understanding of your operating system's command line client.
## Setting up macOS ## Setting up macOS
> Electron supports Mac OS X 10.9 (and all versions named macOS) and up. Apple does > Electron supports Mac OS X 10.9 (and all versions named macOS) and up. Apple
not allow running macOS in virtual machines unless the host computer is already does not allow running macOS in virtual machines unless the host computer is
an Apple computer, so if you find yourself in need of a Mac, consider using a already an Apple computer, so if you find yourself in need of a Mac, consider
cloud service that rents access to Macs (like [MacInCloud][macincloud] or using a cloud service that rents access to Macs (like [MacInCloud][macincloud]
[xcloud](https://xcloud.me)). or [xcloud](https://xcloud.me)).
First, install a recent version of Node.js. We recommend that you install First, install a recent version of Node.js. We recommend that you install
either the latest `LTS` or `Current` version available. Visit either the latest `LTS` or `Current` version available. Visit
[the Node.js download page][node-download] and select the `macOS Installer`. [the Node.js download page][node-download] and select the `macOS Installer`.
While Homebrew is an offered option, but we recommend against it - many tools
will be incompatible with the way Homebrew installs Node.js.
Once downloaded, execute the installer and let the installation wizard guide Once downloaded, execute the installer and let the installation wizard guide
you through the installation. you through the installation.

32
docs/tutorial/first-app.md
View file

@ -37,9 +37,9 @@ run the main process. An example of your `package.json` might look like this:
```json ```json
{ {
"name" : "your-app", "name": "your-app",
"version" : "0.1.0", "version": "0.1.0",
"main" : "main.js" "main": "main.js"
} }
``` ```
@ -50,11 +50,11 @@ to execute the current package:
```json ```json
{ {
"name" : "your-app", "name": "your-app",
"version" : "0.1.0", "version": "0.1.0",
"main" : "main.js", "main": "main.js",
"scripts" : { "scripts": {
"start" : "node ." "start": "node ."
} }
} }
``` ```
@ -64,11 +64,11 @@ merely replace the `node` runtime with the `electron` runtime.
```json ```json
{ {
"name" : "your-app", "name": "your-app",
"version" : "0.1.0", "version": "0.1.0",
"main" : "main.js", "main": "main.js",
"scripts" : { "scripts": {
"start" : "electron ." "start": "electron ."
} }
} }
``` ```
@ -99,9 +99,9 @@ Node.js module:
const electron = require('electron') const electron = require('electron')
``` ```
The `electron` module exposes is feature in namespaces. The lifecycle of the The `electron` module exposes features in namespaces. As examples, the lifecycle
application is managed through `electron.app`, windows can be created using of the application is managed through `electron.app`, windows can be created
the `electron.BrowserWindow` class. A simple `main.js` file might just wait using the `electron.BrowserWindow` class. A simple `main.js` file might just wait
for the application to be ready and open a window: for the application to be ready and open a window:
```javascript ```javascript

2
docs/tutorial/linux-desktop-actions.md
View file

@ -3,7 +3,7 @@
On many Linux environments, you can add custom entries to its launcher On many Linux environments, you can add custom entries to its launcher
by modifying the `.desktop` file. For Canonical's Unity documentation, by modifying the `.desktop` file. For Canonical's Unity documentation,
see [Adding Shortcuts to a Launcher][unity-launcher]. For details on a see [Adding Shortcuts to a Launcher][unity-launcher]. For details on a
more generic implementation, see the [Free Desktop Specification][spec]. more generic implementation, see the [freedesktop.org Specification][spec].
__Launcher shortcuts of Audacious:__ __Launcher shortcuts of Audacious:__