Skip to content

Commit

Permalink
Add README content
Browse files Browse the repository at this point in the history
  • Loading branch information
jleung51 committed Aug 21, 2018
1 parent c1a4f11 commit bb3ce7b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 4 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# Pac Macro Mapview

Website to display the Pac Macro players' locations.
Web application to display the Pac Macro game.

The web application is **not yet available** as a website due to issues with HTTP content served over an HTTPS connection.

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).

![Screenshot](readme-img/screenshot.png)

## Electron Setup

To start the Electron application locally from the project files, install Electron as a development dependency in the project:
```
npm install --save-dev electron
```

Then start the application:
```
npm start
```

To build the executables, run:
```
./build/release.py
```

The distributables will be in `build/` as zip files.
Binary file added readme-img/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions renderer.js

This file was deleted.

0 comments on commit bb3ce7b

Please sign in to comment.