Browse Source

Clarified name argument's default, updated README

ijon 3 years ago
parent
commit
12e1dff197
2 changed files with 19 additions and 1 deletions
  1. 18 0
      README.md
  2. 1 1
      make.py

+ 18 - 0
README.md

@@ -2,6 +2,24 @@
 
 **it build the thing**
 
+```text
+usage: make.py [-h] [-d DIR] [-g OBJ] [-7] [-3] [-n] [-p] [-r] [name]
+
+Compiles all ACS and GDCC code in your project, then stuffs it into a PK3.
+
+positional arguments:
+  name                name of your PK3 (default: directory name)
+
+optional arguments:
+  -h, --help          show this help message and exit
+  -d DIR, --dir DIR   location of your project (default: "pk3")
+  -g OBJ, --gdcc OBJ  name of GDCC object file (default: "gdcc")
+  -7, --pk7           build a PK7 instead of a PK3
+  -3, --pk3           build a PK3 even if building a PK7
+  -n, --nobuild       build nothing, just compile code
+  -p, --noprecompile  don't run any precompile module
+  -r, --recompile     recompile all ACS/GDCC code
+```
 
 ## Dependencies
 

+ 1 - 1
make.py

@@ -372,7 +372,7 @@ if __name__ == "__main__":
     dirname = os.path.basename(os.getcwd()) or "yourproject"
 
     parser = argparse.ArgumentParser(prog="make.py", description="Compiles all ACS and GDCC code in your project, then stuffs it into a PK3.")
-    parser.add_argument("name",                 type=str, default=dirname, nargs="?",  help="name of your PK3 (default: \"{}\")".format(dirname))
+    parser.add_argument("name",                 type=str, default=dirname, nargs="?",  help="name of your PK3 (default: directory name)")
     parser.add_argument("-d", "--dir",          type=str, default="pk3",               help="location of your project (default: \"pk3\")")
     parser.add_argument("-g", "--gdcc",         type=str, default="gdcc", dest="obj",  help="name of GDCC object file (default: \"gdcc\")")
     parser.add_argument("-7", "--pk7",          action="store_true",      dest="pk7",  help="build a PK7 instead of a PK3")