oreolek/salet
1
0
Fork 0
mirror of https://gitlab.com/Oreolek/salet.git synced 2024-04-25 21:59:37 +03:00
Code Issues Releases Wiki Activity

Add building instructions

Browse source
This commit is contained in:
Alexander Yakovlev 2019-09-11 02:24:18 +07:00
parent f5338d5f9e
commit 72de00937c
Signed by: oreolek
GPG key ID: 1CDC4B7820C93BD3
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -4,6 +4,13 @@ A general client-side framework for cybertext interactive fiction games.
**Salet** is based upon [Undum,](https://github.com/idmillington/undum) rewritten in CoffeeScript and altered to its own needs.
It also uses some code from [Raconteur,](https://github.com/sequitur/raconteur) same deal.
## Building
* install NodeJS
* `npm install` - to install packages
* `npm run build` - to build the game (look in `dist` folder)
* `npm run start` - to debug the game (auto-rebuild on any changes)
## License
The code, documentation, styles, design and images are all distributed under the MIT license.