Skip to content

Commit 9a983c1

Browse files
author
Maxime GRIS
committed
update README
1 parent 7a21eb9 commit 9a983c1

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

Diff for: README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,34 @@
44

55
Bootstrap your project with Angular 4 and Electron (Typescript + SASS)
66

7+
Currently runs with:
8+
9+
- Angular v4.0.1
10+
- Angular-CLI v1.0.0
11+
- Electron v1.6.2
12+
- Electron-Prebuilt v1.4.13
13+
14+
## Getting Started
15+
16+
Clone this repository locally :
17+
18+
``` bash
19+
git clone https://github.com/maximegris/angular-electron.git
20+
```
21+
22+
Install dependencies with your favorite dependency manager (npm or yarn) :
23+
24+
``` bash
25+
npm install
26+
```
27+
728
## To build for development
829

930
**in a terminal window** -> npm start
1031
**in another terminal window** -> npm run electron
1132

12-
Note: also works with yarn
33+
The code for this is managed at `main.js`. In this sample, the app runs with a simple Electron window.
34+
By default, Developer tools is opened. You can unactivate it by uncomment `win.webContents.openDevTools();` in `main.js`.
1335

1436
## To build for production
1537

0 commit comments

Comments
 (0)