update README
This commit is contained in:
24
README.md
24
README.md
@@ -4,12 +4,34 @@
|
|||||||
|
|
||||||
Bootstrap your project with Angular 4 and Electron (Typescript + SASS)
|
Bootstrap your project with Angular 4 and Electron (Typescript + SASS)
|
||||||
|
|
||||||
|
Currently runs with:
|
||||||
|
|
||||||
|
- Angular v4.0.1
|
||||||
|
- Angular-CLI v1.0.0
|
||||||
|
- Electron v1.6.2
|
||||||
|
- Electron-Prebuilt v1.4.13
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Clone this repository locally :
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
git clone https://github.com/maximegris/angular-electron.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Install dependencies with your favorite dependency manager (npm or yarn) :
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
## To build for development
|
## To build for development
|
||||||
|
|
||||||
**in a terminal window** -> npm start
|
**in a terminal window** -> npm start
|
||||||
**in another terminal window** -> npm run electron
|
**in another terminal window** -> npm run electron
|
||||||
|
|
||||||
Note: also works with yarn
|
The code for this is managed at `main.js`. In this sample, the app runs with a simple Electron window.
|
||||||
|
By default, Developer tools is opened. You can unactivate it by uncomment `win.webContents.openDevTools();` in `main.js`.
|
||||||
|
|
||||||
## To build for production
|
## To build for production
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user