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

Clean documentation, add dependencies

Browse Source
This commit is contained in:
Antonin Décimo
2015-06-26 19:32:15 +02:00
parent 3034c43cc0
commit d4291daf92
2 changed files with 12 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,7 +1,11 @@
### NAME
`love-release.sh` -- Bash script to generate Love 2D game releases
`love-release.sh` -- Bash script to generate [LÖVE](https://love2d.org/) game releases
### INSTALLATION
`love-release` relies on `GNU sed`, `GNU getopt` (OSX and BSD user needs to install them), `curl`, `zip` and `unzip`.
You need to have `lua` installed to be able to read the configuration.
You also need Wine to get icons and installer for Windows, the Debian pakaging utilities for Debian and the Android SDK to build a package for Android.
First clone the repository, then you have two choices:
- you can build the script and install it on your system, and benefit of command-line completion, man page and extensibility,
- or make an embedded version with every thing you need in one file.
@@ -23,13 +27,10 @@ To remove love-release, if you haven't changed the default installation director
`love-release.sh [-ADLMW] [-t project_title] [-r release_dir] [-l love_version] [FILES...]`
### DESCRIPTION
love-release.sh can be used to generate Love 2D game applications
and get over the fastidious zipping commands you had to do.
love-release.sh can be used to generate LÖVE game applications and get over the fastidious zipping commands you had to do.
The script fully supports Windows, MacOS either on x86 or x64,
Debian and Android packages.
It needs an Internet connection to download Love files,
and relies on `curl`, `zip` and `unzip` commands.
The script fully supports Windows, MacOS either on x86 or x64, Debian and Android packages.
It needs an Internet connection to download LÖVE files.
### CONFIGURATION
You can install `lua` and add a `conf.lua` to your project to get automatic releases.
@@ -182,7 +183,3 @@ but if provided it can use them.
[https://www.love2d.org/wiki/Game_Distribution](https://www.love2d.org/wiki/Game_Distribution)
[https://www.github.com/MisterDA/love-release](https://www.github.com/MisterDA/love-release)
### THANKS
The work done on Debian packaging is highly inspired by what [josefnpat](http://josefnpat.com/) did.
Thanks to him !

11
love-release.1
View File

@@ -1,18 +1,15 @@
.TH LOVE-RELEASE.SH 1
.SH NAME
love-release.sh \- Bash script to generate Love 2D game releases
love-release.sh \- Bash script to generate LÖVE game releases
.SH SYNOPSIS
.B love\-release.sh
[\fB\-ADLMW\fR] [\fB\-t\fR \fIproject_title\fR] [\fB\-r\fR \fIrelease_dir\fR] [\fB\-l\fR \fIlove_version\fR] [\fIFILES...\fR]
.SH DESCRIPTION
.B love-release.sh
can be used to generate Love 2D game applications
and get over the fastidious zipping commands you had to do.
can be used to generate LÖVE game applications and get over the fastidious zipping commands you had to do.
.PP
The script fully supports Windows, MacOS either on x86 or x64,
Debian and Android packages.
It needs an Internet connection to download Love files,
and relies on \fBcurl\fR, \fBzip\fR and \fBunzip\fR commands.
The script fully supports Windows, MacOS either on x86 or x64, Debian and Android packages.
It needs an Internet connection to download LÖVE files.
.SH CONFIGURATION
You can install \fIlua\fR and add a \fIconf.lua\fR to your project to get automatic releases.
See the \fIconf.lua\fR file included to see how configuration works.