diff --git a/README.md b/README.md index d4523ff..ad5d226 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,21 @@ Press `A` and `D` to steer the ship left and right, `W` to move forwards and `K` You can play Mathsteroids at [mscroggs.co.uk/mathsteroids](http://www.mscroggs.co.uk/mathsteroids). +## Building +Mathsteroids can be run directly in a web environment with PHP by navigating to `index.php`. +Alternatively, a pure HTML version can be generated by running: + +``` +make html +``` + +The HTML that this generates will include links to some of the javascript files. To instead +generate a HTML file that inlines all of the javascript, run: + +``` +make html-single-page +``` + ## Surfaces The following surfaces are currently available: