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
Copy file name to clipboardExpand all lines: README.md
+14-13Lines changed: 14 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ should be handled by one dependency in a standard way while still offering users
37
37
maximum choice and freedom.
38
38
39
39
With these goals in mind, under the hood this project uses
40
-
[`electron-compile`](https://github.com/electron/electron-compile). A tool
40
+
[`electron-compile`](https://github.com/electron/electron-compile): a tool
41
41
that lets you use modern and futuristic langauges inside Electron without
42
42
worrying about transpiling or build tooling.
43
43
@@ -68,7 +68,8 @@ Any args after "start" will be passed through to your application when it is lau
68
68
electron-forge package
69
69
```
70
70
71
-
Yes, it really is that simple. If you want to specify platform / arch you the `--platform=<platform>` and `--arch=<arch>` arguments.
71
+
Yes, it really is that simple. If you want to specify platform / arch, use the
72
+
`--platform=<platform>` and `--arch=<arch>` arguments.
72
73
73
74
## Generating a distributable for your Project
74
75
@@ -88,33 +89,33 @@ electron-forge lint
88
89
89
90
Once you have generated a project your `package.json` file will have some default `forge` config. Below is the reference structure for this config object.
90
91
91
-
```js
92
+
```javascript
92
93
{
93
94
"make_targets": {
94
95
"win32": ["squirrel"], // An array of win32 make targets
95
-
"darwin": ["zip"], // An array of darwin make targets
96
-
"linux": ["deb", "rpm"] // An array of linux make targets
96
+
"darwin": ["zip", "dmg"], // An array of darwin make targets
97
+
"linux": ["deb", "rpm", "flatpak"] // An array of linux make targets
97
98
},
98
99
"electronPackagerConfig": {},
99
100
"electronWinstallerConfig": {},
100
101
"electronInstallerDMG": {},
101
102
"electronInstallerFlatpak": {},
102
103
"electronInstallerDebian": {},
103
-
"electronInstallerRedhat": {}
104
+
"electronInstallerRedhat": {}
104
105
}
105
106
```
106
107
107
108
## Possible `make` targets
108
109
109
-
| Target Name | Available Platforms | Description | Configurable Options |
|`zip`| All | Zips your packaged application | None |`zip` on Darwin/Linux |
112
113
|`squirrel`| Windows | Generates an installer and `.nupkg` files for Squirrel.Windows |[`electronWinstallerConfig`](https://github.com/electron/windows-installer#usage)|
113
114
|`dmg`| Darwin | Generates a DMG file |[`electronInstallerDMG`](https://github.com/mongodb-js/electron-installer-dmg#api)|
114
-
|`deb`| Linux | Generates a Debian installer |[`electronInstallerDebian`](https://github.com/unindented/electron-installer-debian#options)|
115
-
|`rpm`| Linux | Generates a Redhat installer |[`electronInstallerRedhat`](https://github.com/unindented/electron-installer-redhat#options)|
116
-
|`flatpak`| Linux | Generates a `flatpak` file |[`electronInstallerFlatpak`](https://github.com/endlessm/electron-installer-flatpak#options)|
115
+
|`deb`| Linux | Generates a Debian installer |[`electronInstallerDebian`](https://github.com/unindented/electron-installer-debian#options)|[`fakeroot` and `dpkg`](https://github.com/unindented/electron-installer-debian#requirements)|
116
+
|`rpm`| Linux | Generates a Redhat installer |[`electronInstallerRedhat`](https://github.com/unindented/electron-installer-redhat#options)|[`rpm`](https://github.com/unindented/electron-installer-redhatn#requirements)|
117
+
|`flatpak`| Linux | Generates a `flatpak` file |[`electronInstallerFlatpak`](https://github.com/endlessm/electron-installer-flatpak#options)|[`flatpak`](https://github.com/endlessm/electron-installer-flatpak#requirements)|
117
118
118
119
## Configuring `package`
119
120
120
-
You can set `electronPackagerConfig` with **any** of the options from [`electron-packager`](https://github.com/electron-userland/electron-packager/blob/master/docs/api.md)
121
+
You can set `electronPackagerConfig` with **any** of the options from [Electron Packager](https://github.com/electron-userland/electron-packager/blob/master/docs/api.md).
0 commit comments