Skip to content

Commit 9249391

Browse files
committed
Merge branch 'master' of github.com:Stephn-R/League_Companion
2 parents 073f4f4 + c6bd4c2 commit 9249391

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
1-
# League_Companion
2-
A Mac/Windows application built in Electron as a companion application to League of Legends
1+
# Electron-Boilerplate
2+
A template for Electron projects to build/publish Mac/Windows/Linux compatible applications
3+
4+
### Installation:
5+
6+
For development, run:
7+
8+
```shell
9+
npm install
10+
npm start
11+
```
12+
13+
As for preparing the Windows/Mac/Linux apps for distribution. You will first need to run the ```npm install```. Afterwards, run the following to build all the apps for all architectures and distributions:
14+
15+
```shell
16+
# Requires GNU Make to be installed
17+
make
18+
```

0 commit comments

Comments
 (0)