diff --git a/README.md b/README.md index e329a77..5f23b3d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,58 @@ Work in progress name, work in progress game +Try the latest build here: [mcg-builds.zyg.ovh/latest](https://mcg-builds.zyg.ovh/latest/) + +## Development + +### Dependencies + +Fetch dependencies with `yarn`: + +```sh +yarn --dev +``` + +### Run local server for development + +Run this command: + +```sh +yarn serve +``` + +then visit [localhost:8080](http://localhost:8080) (URL might be different if something is already listening on port 8080) + +### Run tests + +Run unit tests with Jest: + +```sh +yarn test:unit +``` + +Generate a coverage profile with: + +```sh +yarn test:unit --coverage +``` + +### Lint code + +Before you submit a PR, make sure the code is formatted correctly with: + +```sh +yarn lint +``` + +## Building for release + +### Build + +```sh +yarn build +``` + ## License Code is ISC, Assets "depends", some stuff is taken from FreeSound and DeviantArt so your best bet is to just praise the copyright gods.