From d4291daf923866305af7d65f80ad73fdd8d9aafb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonin=20D=C3=A9cimo?= Date: Fri, 26 Jun 2015 19:32:15 +0200 Subject: [PATCH] Clean documentation, add dependencies --- README.md | 19 ++++++++----------- love-release.1 | 11 ++++------- 2 files changed, 12 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 8fcb2a2..d6a7e64 100644 --- a/README.md +++ b/README.md @@ -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 ! - diff --git a/love-release.1 b/love-release.1 index 8a05202..706d233 100644 --- a/love-release.1 +++ b/love-release.1 @@ -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.