mirror of
https://github.com/owenlejeune/AirHockey.git
synced 2025-11-30 03:02:23 -05:00
Updated README to Markdown
This commit is contained in:
24
README.md
Normal file
24
README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Air Hockey
|
||||
A simple browser-based air hockey game using socket.io with Electron desktop client
|
||||
|
||||
## Development Environment
|
||||
node 8.9.4
|
||||
npm 5.7.1
|
||||
Tested on MacOS 10.13.2
|
||||
|
||||
## Dependencies
|
||||
node.js, Electron, socket.io
|
||||
|
||||
# Installation Instructions
|
||||
..* Clone to local machine
|
||||
..* Run _npm install_ from root directory and Electron Client directory to install node module Dependencies
|
||||
|
||||
# Running the App
|
||||
## Starting the server
|
||||
..* Execute _node app.js_ from root directory to start the app server
|
||||
|
||||
## Browser Client
|
||||
..* Navigate to http://localhost:3000/airhockey.html from your browser
|
||||
|
||||
## Electron Client
|
||||
..* Execute _npm start_ from inside the _Electron Client_ directory to launch the Electron Client
|
||||
Reference in New Issue
Block a user