Codinget/Snek
1
0
Fork 0
Code Issues 11 Pull requests Releases Activity

updated README.md

Browse source
This commit is contained in:
Nathan DECHER 2020-04-08 15:32:00 +02:00
parent 5bf5f49f03
commit 03cb1b83b9
1 changed files with 18 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -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) [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` - All the POSIX tools, most importantly a POSIX-compliant shell, `echo`, `rm`, `seq` and `sed`
- Busybox is known to work - Busybox is known to work
- GNU Coreutils are 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 and npm, both in the PATH
- Node.js 10 and 12 are known to work - Node.js 10 and 12 are known to work
## Running the game ## Running the game (dev)
- Get the Dockerfile - `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 build` it
- `docker run -p80:3000 <whatever you called the container>` - `docker run -it -p80:3000` the container
- ideally, put it behind a reverse proxy - ideally, put it behind a reverse proxy
## License
[MIT](https://opensource.org/licenses/MIT)