Add full 0.9.0 support, and a better help. Remove Love nightlies, configuration and Debian.

README.md

@@ -1,32 +1,51 @@
+### NAME
+`love-release.sh` -- Bash script to generate Love 2D game releases
+
 ### SYNOPSIS
-`love-release.sh [OPTIONS] [FILES...]`
+`love-release.sh [-lmw] [-n project_name] [-r release_dir] [-u company_name] [-v love_version] [FILES...]`
 
 ### DESCRIPTION
-You can use love-release.sh to generate Love2D executables for Linux, OS X, Windows (x86 and x86_64),
-as specified in love2d.org.
-An Internet connection is required. The script uses curl, zip and unzip commands.
-
-By default, the script generates releases for every system. But if you add options, 
-it will generate releases only for the specified systems.
-
-A directory (default is `./releases`) will be created, and filled with the zipped releases:
-`YourGame-win-x86.zip`, `YourGame-win-x64.zip`, `YourGame-osx.zip` and `YourGame.love`.
+You can use love-release.sh to generate Love 2D game applications and get over the fastidious zipping commands you had to do.
+The script fully supports Windows, MacOS either on x86 or x64. 
+It needs an Internet connection to download Love files, and relies on curl, zip and unzip commands.
 
 ### OPTIONS
-- *-h*,  help
-- *-l*,  generates a .love file
-- *-d*,  generates a Debian package **currently not working**
-- *-m*,  generates a Mac OS X app
-- *-w*,  generates Windows x86 and x86_64 executables
-  - *-w32*,  generates Windows x86 executable
-  - *-w64*,  generates Windows x86_64 executable
-- *-r*,  release directory. By default, a subdirectory called `releases` is created
-- *-u*,  company name. Provide it for OSX CFBundleIdentifier, otherwise USER is used
-- *-v*,  love version. Default is 0.8.0. Prior to it, no special Win64 version is available  
-         Use `-v dev` for nightly builds
-- *--refresh*,  refresh the cache located in `~/.cache/love-release`
-- *--debug*,    dumps script variables. Does not make releases
+`-h`     Print a short help  
+`--help` Print this longer help
+
+#### OPERATING SYSTEMS
+`-l` Create a plain Love file. It is just a zip of your sources, renamed in *.love.
+     Mostly aimed at Linux players or developpers and the most common distribution process.
+
+`-m` Create MacOS application.
+     Starting with Love 0.9.0, Love no longer supports old x86 Macintosh. 
+     If you are targeting one of these, your project must be developped with Love 0.8.0 or lower.
+     Depending on the Love version used, the script will choose which one, between x64 only or Universal Build to create.
+    
+`-w` Create Windows application.
+     Starting with Love 0.8.0, a release is specially available for Windows x64.
+     If you are targeting one of these, your project must be developped with Love 0.8.0 or newer.
+     Remember that x86 is always backwards compatible with x64.
+     Depending on the Love version used, the script will choose which one, between x64 and x86 or x86 only to create.  
+`-w32`  Create Windows x86 executable only  
+`-w64`  Create Windows x64 executable only
+
+#### PROJECT OPTIONS
+`-n`  Set the projects name. By default, the name of the current directory is used.
+
+`-r`  Set the release directory. By default, a subdirectory called releases is created.
+
+`-u`  Set the company name. Provide it for MacOS CFBundleIdentifier.
+
+`-v`  Love version. Default is 0.9.0.
+      Starting with Love 0.8.0, a release is specially available for Windows x64.
+      Starting with Love 0.9.0, Love no longer supports old x86 Macintosh.
+
+#### OTHERS
+`--refresh`   Refresh the cache located in `~/.cache/love-release`. One can replace the Love files there.  
+`--debug`     Dump the scripts variables without making releases.
 
 ### SEE ALSO
-- [https://www.love2d.org](https://www.love2d.org)
-- [https://www.love2d.org/wiki/Game_Distribution](https://www.love2d.org/wiki/Game_Distribution)
+[https://www.love2d.org](https://www.love2d.org)  
+[https://www.love2d.org/wiki/Game_Distribution](https://www.love2d.org/wiki/Game_Distribution)  
+[https://www.github.org/MisterDA/love-release](https://www.github.org/MisterDA/love-release)