From ff33b0f1e05b45090cb972ae9dace7dcf7a3f348 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonin=20D=C3=A9cimo?= Date: Tue, 16 Jul 2019 10:12:15 +0200 Subject: [PATCH] Document required script parameters --- README.md | 12 ++++++------ src/pipes/args.lua | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 98334df..387a4e6 100644 --- a/README.md +++ b/README.md @@ -44,23 +44,23 @@ Options: -M MacOS X application. -W [32|64] Windows executable. -a , --author - Author full name. + Author full name. Required for Debian. -b Compile new or updated files to LuaJIT bytecode. -d , --desc - Project description. + Project description. Required for Debian. -e , --email - Author email. + Author email. Required for Debian. -l , --love LÖVE version to use. -p , --package Package and command name. -t , --title <title> Project title. - -u <url>, --url <url> Project homepage url. - --uti <uti> Project Uniform Type Identifier. + -u <url>, --url <url> Project homepage url. Required for Debian. + --uti <uti> Project Uniform Type Identifier. Required for macOS. -x <exclude_pattern>, --exclude <exclude_pattern> Exclude file patterns. - -v <v> Project version. + -v <v> Project version. Required for Debian. -h, --help Show this help message and exit. For more info, see https://github.com/MisterDA/love-release diff --git a/src/pipes/args.lua b/src/pipes/args.lua index 53160e2..c417fd2 100644 --- a/src/pipes/args.lua +++ b/src/pipes/args.lua @@ -37,18 +37,18 @@ function Args:initialize() :count "0-2" :argname "32|64" - parser:option("-a --author", "Author full name.") + parser:option("-a --author", "Author full name. Required for Debian.") parser:flag("-b", "Compile new or updated files to LuaJIT bytecode.") :target("compile") - parser:option("-d --desc", "Project description.") - parser:option("-e --email", "Author email.") + parser:option("-d --desc", "Project description. Required for Debian.") + parser:option("-e --email", "Author email. Required for Debian.") parser:option("-l --love", "LÖVE version to use.") :target("loveVersion") parser:option("-p --package", "Package and command name.") parser:option("-t --title", "Project title.") - parser:option("-u --url", "Project homepage url.") - parser:option("--uti", "Project Uniform Type Identifier.") - parser:option("-v", "Project version.") + parser:option("-u --url", "Project homepage url. Required for Debian.") + parser:option("--uti", "Project Uniform Type Identifier. Required for macOS.") + parser:option("-v", "Project version. Required for Debian.") :target("version") parser:option("-x --exclude", "Exclude file patterns."):count("*") :target("excludeFileList")