Merge branch '1-0-release'
This commit is contained in:
commit
0f52a6da39
39 changed files with 72 additions and 459 deletions
|
@ -30,8 +30,9 @@ This is a requirement of `Squirrel.Mac`.
|
|||
### Windows
|
||||
|
||||
On Windows, you have to install your app into a user's machine before you can
|
||||
use the auto-updater, so it is recommended to use
|
||||
[grunt-electron-installer][installer] module to generate a Windows installer.
|
||||
use the `autoUpdater`, so it is recommended that you use the
|
||||
[electron-winstaller][installer-lib] module or the [grunt-electron-installer][installer]
|
||||
package to generate a Windows installer.
|
||||
|
||||
The installer generated with Squirrel will create a shortcut icon with an
|
||||
[Application User Model ID][app-user-model-id] in the format of
|
||||
|
@ -111,7 +112,8 @@ should only be called after `update-downloaded` has been emitted.
|
|||
[squirrel-mac]: https://github.com/Squirrel/Squirrel.Mac
|
||||
[server-support]: https://github.com/Squirrel/Squirrel.Mac#server-support
|
||||
[squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows
|
||||
[installer]: https://github.com/atom/grunt-electron-installer
|
||||
[installer]: https://github.com/electron/grunt-electron-installer
|
||||
[installer-lib]: https://github.com/electron/windows-installer
|
||||
[app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
|
||||
[electron-release-server]: https://github.com/ArekSredzki/electron-release-server
|
||||
[squirrel-updates-server]: https://github.com/Aluxian/squirrel-updates-server
|
||||
|
|
|
@ -20,7 +20,7 @@ For setting up a server to accept and process crash reports, you can use
|
|||
following projects:
|
||||
|
||||
* [socorro](https://github.com/mozilla/socorro)
|
||||
* [mini-breakpad-server](https://github.com/atom/mini-breakpad-server)
|
||||
* [mini-breakpad-server](https://github.com/electron/mini-breakpad-server)
|
||||
|
||||
## Methods
|
||||
|
||||
|
|
|
@ -52,7 +52,3 @@ Don't attach to current console session.
|
|||
## `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_
|
||||
|
||||
Don't use global menu bar on Linux.
|
||||
|
||||
## `ELECTRON_HIDE_INTERNAL_MODULES`
|
||||
|
||||
Turns off compatibility mode for old built-in modules like `require('ipc')`.
|
||||
|
|
|
@ -72,25 +72,6 @@ const app = electron.app;
|
|||
const BrowserWindow = electron.BrowserWindow;
|
||||
```
|
||||
|
||||
## Disable old styles of using built-in modules
|
||||
|
||||
Before v0.35.0, all built-in modules have to be used in the form of
|
||||
`require('module-name')`, though it has [many disadvantages][issue-387], we are
|
||||
still supporting it for compatibility with old apps.
|
||||
|
||||
To disable the old styles completely, you can set the
|
||||
`ELECTRON_HIDE_INTERNAL_MODULES` environment variable:
|
||||
|
||||
```javascript
|
||||
process.env.ELECTRON_HIDE_INTERNAL_MODULES = 'true'
|
||||
```
|
||||
|
||||
Or call the `hideInternalModules` API:
|
||||
|
||||
```javascript
|
||||
require('electron').hideInternalModules();
|
||||
```
|
||||
|
||||
[gui]: https://en.wikipedia.org/wiki/Graphical_user_interface
|
||||
[destructuring-assignment]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
|
||||
[issue-387]: https://github.com/electron/electron/issues/387
|
||||
|
|
|
@ -66,7 +66,7 @@ Electron
|
|||
## Keeping Git Submodules Up to Date
|
||||
|
||||
The Electron repository has a few vendored dependencies, found in the
|
||||
[/vendor](/vendor) directory. Occasionally you might see a message like this
|
||||
[/vendor][vendor] directory. Occasionally you might see a message like this
|
||||
when running `git status`:
|
||||
|
||||
```sh
|
||||
|
@ -89,3 +89,5 @@ in your `~/.gitconfig` file:
|
|||
[alias]
|
||||
su = submodule update --init --recursive
|
||||
```
|
||||
|
||||
[vendor]: https://github.com/electron/electron/tree/master/vendor
|
||||
|
|
|
@ -30,7 +30,7 @@ your distribution to deliver to final users.
|
|||
## Packaging Your App into a File
|
||||
|
||||
Apart from shipping your app by copying all of its source files, you can also
|
||||
package your app into an [asar](https://github.com/atom/asar) archive to avoid
|
||||
package your app into an [asar](https://github.com/electron/asar) archive to avoid
|
||||
exposing your app's source code to users.
|
||||
|
||||
To use an `asar` archive to replace the `app` folder, you need to rename the
|
||||
|
|
|
@ -181,4 +181,4 @@ After running the command, apart from the `app.asar`, there is also an
|
|||
`app.asar.unpacked` folder generated which contains the unpacked files, you
|
||||
should copy it together with `app.asar` when shipping it to users.
|
||||
|
||||
[asar]: https://github.com/atom/asar
|
||||
[asar]: https://github.com/electron/asar
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue