Skip to content

Commit bb3ce7b

Browse files
committed
Add README content
1 parent c1a4f11 commit bb3ce7b

3 files changed

Lines changed: 26 additions & 4 deletions

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
11
# Pac Macro Mapview
22

3-
Website to display the Pac Macro players' locations.
3+
Web application to display the Pac Macro game.
4+
5+
The web application is **not yet available** as a website due to issues with HTTP content served over an HTTPS connection.
6+
7+
To run the web application, download the project and open `index.html` in a browser. An [Electron](https://electronjs.org) application is also available as an option - [download the correct executable for your operating system](https://github.com/pacmacro/pacmacro.github.io/releases).
8+
9+
![Screenshot](readme-img/screenshot.png)
10+
11+
## Electron Setup
12+
13+
To start the Electron application locally from the project files, install Electron as a development dependency in the project:
14+
```
15+
npm install --save-dev electron
16+
```
17+
18+
Then start the application:
19+
```
20+
npm start
21+
```
22+
23+
To build the executables, run:
24+
```
25+
./build/release.py
26+
```
27+
28+
The distributables will be in `build/` as zip files.

readme-img/screenshot.png

574 KB
Loading

renderer.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)