Skip to content

Commit 6a5b75b

Browse files
committed
Update README
- Fixed #2: Fixed incorrect command `npm run install` to `npm install`. - Added sections for `npm start` command and `Known issues`.
1 parent d2aa88c commit 6a5b75b

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This boilerplate currently works on macOS and Windows. If something doesn't
66
work, please [file and issue](https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/issues/new).
77

88
## Getting started
9-
```bash
9+
```sh
1010
// execute
1111
git clone https://github.com/iamWing/electron-react-typescript-base-proj.git
1212
```
@@ -32,28 +32,34 @@ git clone https://github.com/iamWing/electron-react-typescript-base-proj.git
3232
```
3333

3434
Then install all the `node_modules` needed by executing the following command:
35-
```bash
35+
```sh
3636
cd folder-containing-the-cloned-boilerplate
37-
npm run install
37+
npm install
3838
```
3939

4040
Finally execute the following command to start Webpack in development mode and
41-
watch the changes on source files.
42-
```bash
41+
watch the changes on source files for live rebuild on code changes.
42+
```sh
4343
npm run dev
4444
```
4545

46+
The `npm run dev` command won't start your app and get your app shows on the
47+
screen. To start your app, execute the following command:
48+
```sh
49+
npm start
50+
```
51+
4652
## Building the installer for your Electron app
4753
The boilerplate is currently configured to package & build the installer of
4854
your app for macOS & Windows using `electron-builder`.
4955

5056
For macOS, execute:
51-
```bash
57+
```sh
5258
npm run build:mac
5359
```
5460

5561
For Windows, execute:
56-
```bash
62+
```sh
5763
npm run build:win
5864
```
5965
_** `asar` archiving is disabled by default in Windows build as it can cause
@@ -77,6 +83,7 @@ possible by changing the build scripts in `package.json` as below:
7783
"scripts": {
7884
...
7985
"build:win": "electron-builder build --win --ia32",
86+
// Works only on macOS version < 10.15
8087
"build:mac": "electron-builder build --mac --ia32"
8188
},
8289
```
@@ -85,6 +92,19 @@ Builds for Linux, armv71, and arm64 can also be configured by modifying the
8592
build scripts in `package.json`, but those aren't tested yet. For details,
8693
please refer to [documents of `electron-builder`](https://www.electron.build/cli).
8794

95+
## Known issues
96+
97+
- `dmg` build action on `macOS Catalina (10.15)` fails due to Apple ditches
98+
support for 32-bit apps from `10.15` onwards (Don't worry, you are still
99+
building 64-bit apps, just some dependencies of the builder are still 32-bit).
100+
Further details retailed to this issue can be found
101+
[here](https://github.com/electron-userland/electron-builder/issues/3990).
102+
Application installer built on `macOS` is now set to build `pkg` file
103+
instead of `dmg` as a workaround in the current version. The issue can be
104+
fixed by applying a major version upgrade of `electron-builder` to `21.2.0+`
105+
but it hasn't been tested on this boilerplate yet. This issue is planned to
106+
be addressed alongside with major version upgrades on other dependencies.
107+
88108
## Folder structure
89109
```
90110
electron-react-typescript-base-proj/

0 commit comments

Comments
 (0)