mirror of
https://github.com/Oreolek/ink-instead.git
synced 2024-07-16 21:44:38 +03:00
Update README.md
This commit is contained in:
parent
ab5d6e82e7
commit
29e96a3363
13
README.md
13
README.md
|
@ -27,16 +27,17 @@ Let me know if you want to use it too.
|
||||||
|
|
||||||
## Install dependencies
|
## 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
|
sudo aptitude install luarocks
|
||||||
|
|
||||||
2. install lpeg
|
Install lpeg:
|
||||||
|
|
||||||
luarocks install --local lpeg
|
luarocks install --local lpeg
|
||||||
|
|
||||||
3. get pink
|
Get pink:
|
||||||
Clone this repo or download an archive from [releases](../../releases) page. You need just the `pink` subdirectory.
|
|
||||||
|
Clone this repo or download an archive from [releases](../../releases) page. You need just the `pink` subdirectory.
|
||||||
|
|
||||||
### Note on dependencies
|
### 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))
|
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))
|
||||||
|
|
Loading…
Reference in a new issue