Merge pull request #12 from schwal10/master

Refactor and HUD

README.md

@@ -12,8 +12,28 @@ Light reading can be found on Wikipedia's [After Dark](https://en.wikipedia.org/
 Original foundation was written by [James Carnley](http://jamescarnley.com). Google Code [Project](https://code.google.com/p/lunatic-fringe/).
 
 ## Usage
-1. Open index.html in browser
-2. Play
+NOTE: With the refactor that separated out the code into multiple files, it is no longer possible to just open up index.html in a browser due to being blocked by CORS policy. So until I think of a way to handle this to potentially get around that without requiring that you turn off blocking for CORS violations, the best way to run this locally is to run a local server to host the files. There are multiple ways you could do this, but some of the easiest ways are probably as follows:
+#### VS Code Server
+1. Download Visual Studio Code (it's free) https://code.visualstudio.com/
+2. Find an extenstion for Visual Studio Code for running a local server (Live Server is one I found that has lots of downloads and a high star rating https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer&ssr=false#review-details)
+3. Open the folder containing the code on your local machine
+4. Start your local server (for the Live Server extenstion, you should be able to just click the 'Go Live' button in the bottom right corner of the Visual Studio Code window)
+5. Play
+#### Python Server (https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server):
+1. Download Python 3 (it's free) https://www.python.org/downloads/
+2. Open a terminal/cmd window in the folder containing the code on your local machine
+3. Run the command `python3 -m http.server1`
+4. Go to `http://localhost:8000` in the browser
+5. Play
+
+## Controls
+* Up Arrow key: Accelerate
+* Left Arrow key: Turn left
+* Right Arrow key: Turn right
+* Spacebar: Shoot
+* CapsLock: Pause/Unpause
+* V: Use invulnerability powerup (if available)
+* B: Use turbo boost powerup (if available)
 
 ## Hey the origial game had X!
 This is a work in progress. You are welcome to submit issues. Please search before creating a new one. For the more technically inclined fork and submit pull requests.