You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[Publishing artifacts to GitHub Releases](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts).
16
16
17
17
[electron-packager](https://github.com/electron-userland/electron-packager) and
@@ -59,9 +59,9 @@ For a production app you need to sign your application, see [Where to buy code s
59
59
```
60
60
See [options](https://github.com/electron-userland/electron-builder/wiki/Options). This object will be used as a source of [electron-packager](https://www.npmjs.com/package/electron-packager#packageropts-callback) options. You can specify any other options here.
61
61
62
-
3. Create directory `build` in the root of the project and put your `background.png` (OS X DMG background), `icon.icns` (OS X app icon) and `icon.ico` (Windows app icon).
62
+
3. Create directory `build` in the root of the project and put your `background.png` (MacOS DMG background), `icon.icns` (MacOS app icon) and `icon.ico` (Windows app icon).
63
63
64
-
<a id="user-content-linuxIcon" class="anchor" href="#linuxIcon" aria-hidden="true"></a>Linux icon set will be generated automatically on the fly from the OS X `icns` file (or you can put them into the `build/icons` directory — filename must contains size (e.g. `32x32.png`)).
64
+
<a id="user-content-linuxIcon" class="anchor" href="#linuxIcon" aria-hidden="true"></a>Linux icon set will be generated automatically on the fly from the MacOS `icns` file (or you can put them into the `build/icons` directory — filename must contains size (e.g. `32x32.png`)).
65
65
66
66
4. Add [scripts](https://docs.npmjs.com/cli/run-script) to the development `package.json`:
67
67
```json
@@ -80,7 +80,7 @@ Please note — packaged into an asar archive [by default](https://github.com/el
80
80
# Auto Update
81
81
`electron-builder` produces all required artifacts:
82
82
83
-
* `.dmg`: OS X installer, required for OS X user to initial install.
83
+
* `.dmg`: MacOS installer, required for MacOS user to initial install.
84
84
* `-mac.zip`: required for Squirrel.Mac.
85
85
* `.exe` and `-ia32.exe`: Windows installer, required for Windows user to initial install. Please note — [your app must handle Squirrel.Windows events](https://github.com/electronjs/windows-installer#handling-squirrel-events). See [real example](https://github.com/develar/onshape-desktop-shell/blob/master/src/WinSquirrelStartupEventHandler.ts).
86
86
* `.full-nupkg`: required for Squirrel.Windows.
@@ -95,17 +95,17 @@ For windows consider only [distributing 64-bit versions](https://github.com/elec
95
95
# CLI Usage
96
96
Execute `node_modules/.bin/build --help` to get actual CLI usage guide.
97
97
```
98
-
--osx, -o Build for OS X [array]
98
+
--mac, -o Build for MacOS[array]
99
99
--linux, -l Build for Linux [array]
100
100
--win, -w, --windows Build for Windows [array]
101
101
--x64 Build for x64 [boolean]
102
102
--ia32 Build for ia32 [boolean]
103
103
--publish, -p Publish artifacts (to GitHub Releases), see
Copy file name to clipboardExpand all lines: docs/Multi Platform Build.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,33 +3,33 @@ Don't expect that you can build app for all platforms on one platform.
3
3
* If your app has native dependencies, it can be compiled only on the target platform.
4
4
[prebuild](https://www.npmjs.com/package/prebuild) is a solution, but most node modules [don't provide](https://github.com/atom/node-keytar/issues/27) prebuilt binaries.
5
5
6
-
* OS Code Signing works only on OS X. [Cannot be fixed](http://stackoverflow.com/a/12156576).
6
+
* OS Code Signing works only on MacOS. [Cannot be fixed](http://stackoverflow.com/a/12156576).
7
7
8
-
Don't think that mentioned issues are major, you should use build servers — e.g. [AppVeyor](http://www.appveyor.com/) to build Windows app and [Travis](https://travis-ci.org) to build OS X/Linux apps.
8
+
Don't think that mentioned issues are major, you should use build servers — e.g. [AppVeyor](http://www.appveyor.com/) to build Windows app and [Travis](https://travis-ci.org) to build MacOS/Linux apps.
9
9
10
10
See [sample appveyor.yml](https://github.com/develar/onshape-desktop-shell/blob/master/appveyor.yml) to build Electron app for Windows.
11
-
And [sample .travis.yml](https://github.com/develar/onshape-desktop-shell/blob/master/.travis.yml) to build Electron app for OS X.
11
+
And [sample .travis.yml](https://github.com/develar/onshape-desktop-shell/blob/master/.travis.yml) to build Electron app for MacOS.
12
12
13
13
By default build for current platform and current arch. Use CLI flags `--osx`, `--win`, `--linux` to specify platforms. And `--ia32`, `--x64` to specify arch.
14
14
15
-
For example, to build app for OS X, Windows and Linux:
15
+
For example, to build app for MacOS, Windows and Linux:
16
16
```
17
-
npm run build -owl
17
+
build -mwl
18
18
```
19
19
20
20
Build performed in parallel, so, it is highly recommended to not use npm task per platform (e.g. `npm run dist:osx && npm run dist:win32`), but specify multiple platforms/targets in one build command.
21
21
You don't need to clean dist output before build — output directory is cleaned automatically.
22
22
23
-
## OS X
23
+
## MacOS
24
24
25
25
Use [brew](http://brew.sh) to install required packages.
26
26
27
-
To build app in distributable format for Windows on OS X:
27
+
To build app in distributable format for Windows on MacOS:
28
28
```
29
29
brew install Caskroom/cask/xquartz wine mono
30
30
```
31
31
32
-
To build app in distributable format for Linux on OS X:
32
+
To build app in distributable format for Linux on MacOS:
0 commit comments