owen/AirHockey
1
0
Fork 0
mirror of https://github.com/owenlejeune/AirHockey.git synced 2025-11-10 17:42:46 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated README to Markdown

Browse Source
This commit is contained in:
Owen
2018-03-09 17:02:12 -05:00
parent 547a4c83da
commit 6109d1e012
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,12 +1,12 @@
# Air Hockey
A simple browser-based air hockey game using socket.io with Electron desktop client
## Development Environment
### Development Environment
node 8.9.4
npm 5.7.1
Tested on MacOS 10.13.2
## Dependencies
### Dependencies
node.js, Electron, socket.io
# Installation Instructions
@@ -14,11 +14,11 @@ node.js, Electron, socket.io
* Run _npm install_ from root directory and Electron Client directory to install node module Dependencies
# Running the App
## Starting the server
### Starting the server
* Execute _node app.js_ from root directory to start the app server
## Browser Client
### Browser Client
* Navigate to http://localhost:3000/airhockey.html from your browser
## Electron Client
### Electron Client
* Execute _npm start_ from inside the _Electron Client_ directory to launch the Electron Client