Add README

This commit is contained in:
Ketchetwahmeegwun T. Southall 2022-01-29 12:13:03 -08:00
parent 82c9cffdbc
commit b8eb2514be

17
Engine/README.md Normal file
View File

@ -0,0 +1,17 @@
# GGJ22 Engine
This engine is a Typescript-based engine for GGJ22. It reads files in the yet-to-be-publicly released Vio formats.
## Installation & Running
Ensure you have node installed, preferably node v16. Download from [here](https://nodejs.org/en/download/).
After installing, open a terminal or command prompt in this directory and issue the following commands:
```
npm i
```
```
npx parcel index.html
```
You can now access the game at [http://localhost:1234](http://localhost:1234).