oreolek/ink-instead
1
0
Fork 0
mirror of https://github.com/Oreolek/ink-instead.git synced 2024-07-08 01:24:39 +03:00
Code Issues Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Přemek Vyhnal 2017-01-14 01:29:56 +01:00 committed by GitHub
parent 0ef5f2227c
commit 5a52de4270
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -2,9 +2,9 @@
An attempt to implement a subset of [ink](https://github.com/inkle/ink) in lua using [lpeg](http://www.inf.puc-rio.br/~roberto/lpeg)
## How to use this to run a game
See the examples directory.
See the examples directory for a simple text based example and a LÖVE integration.
This is how to run the simple text-based example:
This is how to run the text-based example:
$ lua examples/game.lua
@ -13,6 +13,7 @@ And this example shows [LÖVE](https://love2d.org) integration:
$ love examples/love2d
<!-- TODO: short example here -->
To use it in your project download the latest source or the latest [release](../../releases). You need just the [pink](../../tree/master/pink) directory.
## How to run tests
$ lua test.lua