oreolek/ink-instead
1
0
Fork 0
mirror of https://github.com/Oreolek/ink-instead.git synced 2024-04-28 15:19:25 +03:00
Code Issues Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Přemek Vyhnal 2017-01-15 23:33:28 +01:00 committed by GitHub
parent ab5d6e82e7
commit 29e96a3363
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -27,16 +27,17 @@ Let me know if you want to use it too.
## Install dependencies
1. install luarocks (Or see https://luarocks.org/#quick-start for instructions for other platforms)
Install luarocks (Or see https://luarocks.org/#quick-start for instructions for other platforms):
sudo aptitude install luarocks
2. install lpeg
Install lpeg:
luarocks install --local lpeg
3. get pink
Clone this repo or download an archive from [releases](../../releases) page. You need just the `pink` subdirectory.
Get pink:
Clone this repo or download an archive from [releases](../../releases) page. You need just the `pink` subdirectory.
### Note on dependencies
The pink **parser** depends on lpeg which can easily be instaled by luarocks (see above) but it may be difficult to distribute it with your game for each platform (it is a C library). Please consider compiling the .ink file into lua table, save it into a file and distribute just the compiled file with a lua table instead of compiling at runtime. (See: [#3](/../../issues/3))