diff --git a/README.md b/README.md index 0d5b7c2..b7cd257 100644 --- a/README.md +++ b/README.md @@ -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))