From 03cb1b83b97c7b42fc31fa82685a047ccc593f42 Mon Sep 17 00:00:00 2001 From: Nathan DECHER Date: Wed, 8 Apr 2020 15:32:00 +0200 Subject: [PATCH] updated README.md --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4f64100..14af472 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,12 @@ A "simple" Snake, done as my final JS class project [Original subject](https://perso.liris.cnrs.fr/pierre-antoine.champin/enseignement/intro-js/s6.html) -## Dependencies +## Features +- 60 FPS 2D animations +- arcade and speedrun game modes +- touchscreen and controller support + +## Dev dependencies - All the POSIX tools, most importantly a POSIX-compliant shell, `echo`, `rm`, `seq` and `sed` - Busybox is known to work - GNU Coreutils are known to work @@ -15,8 +20,17 @@ A "simple" Snake, done as my final JS class project - Node.js and npm, both in the PATH - Node.js 10 and 12 are known to work -## Running the game -- Get the Dockerfile +## Running the game (dev) +- `git clone` this repo +- `npm install` the dependencies +- `make` the ressources +- `npm start` the server + +## Running the game (prod) +- Get the [Dockerfile](https://gitdab.com/Codinget/Snek/raw/branch/master/Dockerfile) - `docker build` it -- `docker run -p80:3000 ` +- `docker run -it -p80:3000` the container - ideally, put it behind a reverse proxy + +## License +[MIT](https://opensource.org/licenses/MIT)