Add note about lua-zip fork

This commit is contained in:
Antonin Décimo
2018-04-23 13:31:13 +02:00
parent 0223b0f4df
commit 8565630963

View File

@@ -85,7 +85,7 @@ end
love-release is only installable through LuaRocks and highly depends on LuaRocks internal API. love-release is currently build on LuaRocks 2.3.0. LuaRocks API is not meant to be stable, and a future update could break love-release. As love-release is made for LÖVE, it is written for Lua 5.1.
#### Required
- [libzip][libzip] headers for lua-libzip.
- [libzip][libzip] and its headers for lua-libzip.
- Other libraries are automatically installed, but let's give them some credit: [lua-libzip][lua-libzip], [luafilesystem][lfs], [loadconf][loadconf], [middleclass][middleclass], [semver][semver].
#### Optional
@@ -93,12 +93,13 @@ love-release is only installable through LuaRocks and highly depends on LuaRocks
- `fakeroot` and `dpkg-deb` are required to create Debian packages.
- [LuaJIT][luajit] can be used to compile your sources, either with `luarocks-luajit` or if `luajit` is installed.
##### Lua binding to libzip
love-release depends on a Lua binding to [libzip][libzip]. I have forked [brimworks/lua-zip][lua-zip] to integrate new features, and published the fork under the name of [lua-libzip][lua-libzip] in [LuaRocks][lua-libzip-rock]. The name will change when LuaRocks 3 will be released.
### Install
```sh
# sudo
luarocks install --server=http://luarocks.org/dev lua-zip
# latest stable version
luarocks install love-release
@@ -130,7 +131,9 @@ Every bug report or feature request is gladly welcome !
[lua]: http://www.lua.org/
[luajit]: http://luajit.org/
[luarocks]: https://luarocks.org/
[lua-zip]: https://github.com/brimworks/lua-zip
[lua-libzip]: https://github.com/misterda/lua-zip
[lua-libzip-rock]: https://luarocks.org/modules/rucikir/lua-libzip
[loadconf]: https://github.com/Alloyed/loadconf
[middleclass]: https://github.com/kikito/middleclass
[package]: https://luarocks.org/modules/rucikir/love-release