mirrors/love-release
1
0
Fork 0
mirror of https://github.com/TangentFoxy/love-release.git synced 2025-07-28 02:52:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Antonin Décimo
2018-12-05 20:02:26 +01:00
parent d979bd38f6
commit d142597ba1
1 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -2,14 +2,14 @@
[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)
[![Build Status](https://travis-ci.org/MisterDA/love-release.svg?branch=master)](https://travis-ci.org/MisterDA/love-release)
[![Coverage Status](https://coveralls.io/repos/github/MisterDA/love-release/badge.svg?branch=master)](https://coveralls.io/github/MisterDA/love-release?branch=master)
[![LuaRocks](https://img.shields.io/badge/LuaRocks-2.0.8-blue.svg)](https://luarocks.org/modules/rucikir/love-release)
[![LuaRocks](https://img.shields.io/badge/LuaRocks-blue.svg)](https://luarocks.org/modules/rucikir/love-release)
![Lua](https://img.shields.io/badge/Lua-5.1%2C%20JIT-blue.svg)
[Lua][lua] script that makes [LÖVE][love] game release easier (previously
Bash script).
Automates LÖVE [Game Distribution][game_dist].
LÖVE [forum topic][forum_topic].
Available as a [LuaRocks][luarocks] [package][package].
Bash script).\
Automates LÖVE [Game Distribution][game_dist].\
LÖVE [forum topic][forum_topic].\
Available as a [LuaRocks 3][luarocks] [package][package].
## Features
love-release makes your LÖVE game release easier. love-release can
@@ -95,14 +95,14 @@ end
### Dependencies
love-release is only installable through LuaRocks and highly depends
on LuaRocks internal API. love-release is currently built on LuaRocks
2.3.0. LuaRocks API is not meant to be stable, and a future update
3.0.x. LuaRocks API is not meant to be stable, and a future update
could break love-release.
#### Required
- [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].
some credit: [luafilesystem][lfs], [loadconf][loadconf],
[middleclass][middleclass], [semver][semver].
#### Optional
- `love` can be used to determine your system LÖVE version.
@@ -113,10 +113,10 @@ could break love-release.
##### 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 is
released.
forked [brimworks/lua-zip][brimworks-lua-zip] to
[misterda/lua-zip][misterda-lua-zip] in order integrate new features,
and published the fork under my namespace in LuaRocks,
[rucikir/lua-zip][rucikir-lua-zip-rock].
### Install
@@ -158,9 +158,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
[brimworks-lua-zip]: https://github.com/brimworks/lua-zip
[misterda-lua-zip]: https://github.com/misterda/lua-zip
[rucikir-lua-zip-rock]: https://luarocks.org/modules/rucikir/lua-zip
[loadconf]: https://github.com/Alloyed/loadconf
[middleclass]: https://github.com/kikito/middleclass
[package]: https://luarocks.org/modules/rucikir/love-release