Skip to content

Commit c6ededf

Browse files
maleptMarshallOfSound
authored andcommitted
docs(generic): tweak the readme
1 parent e909a0c commit c6ededf

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ should be handled by one dependency in a standard way while still offering users
3737
maximum choice and freedom.
3838

3939
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
4141
that lets you use modern and futuristic langauges inside Electron without
4242
worrying about transpiling or build tooling.
4343

@@ -68,7 +68,8 @@ Any args after "start" will be passed through to your application when it is lau
6868
electron-forge package
6969
```
7070

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.
7273

7374
## Generating a distributable for your Project
7475

@@ -88,33 +89,33 @@ electron-forge lint
8889

8990
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.
9091

91-
```js
92+
```javascript
9293
{
9394
"make_targets": {
9495
"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
9798
},
9899
"electronPackagerConfig": {},
99100
"electronWinstallerConfig": {},
100101
"electronInstallerDMG": {},
101102
"electronInstallerFlatpak": {},
102103
"electronInstallerDebian": {},
103-
"electronInstallerRedhat": {}
104+
"electronInstallerRedhat": {}
104105
}
105106
```
106107

107108
## Possible `make` targets
108109

109-
| Target Name | Available Platforms | Description | Configurable Options |
110-
|-------------|---------------------|-------------|----------------------|
111-
| `zip` | All | Zips your packaged application | None |
110+
| Target Name | Available Platforms | Description | Configurable Options | Requirements |
111+
|-------------|---------------------|-------------|----------------------|--------------|
112+
| `zip` | All | Zips your packaged application | None | `zip` on Darwin/Linux |
112113
| `squirrel` | Windows | Generates an installer and `.nupkg` files for Squirrel.Windows | [`electronWinstallerConfig`](https://github.com/electron/windows-installer#usage) |
113114
| `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) |
117118

118119
## Configuring `package`
119120

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

Comments
 (0)