aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Austein <sra@hactrn.net>2019-03-10 14:46:38 -0400
committerRob Austein <sra@hactrn.net>2019-03-10 14:46:38 -0400
commit3beadcbabe6990f4e88de25107d69ce8b6984d6a (patch)
treef1e902be0ef0c33fc18be88cc72855b12a96a8e1
parentfa9a04b06a7c6f62979c506b9999abf6b2eb8208 (diff)
A bit more documentation.
-rw-r--r--Makefile3
-rw-r--r--README.md27
2 files changed, 30 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index dea4629..5975973 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,6 @@
+# Makefile to drive tests. You don't need this if you just want to
+# use pyzipper yourself.
+
SRC := $(wildcard demo[0-9])
BIN := $(addsuffix .zip,${SRC})
diff --git a/README.md b/README.md
index d248b1d..6d88824 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,9 @@ just ties it all together with a bow.
`demo1` and `demo2` are two trivial sample packages.
+The `Makefile` is just a driver for the demos. `pyzipper` itself is
+all you need if you want to use this yourself.
+
Tested with both Python 2 and Python 3, should work with either.
How it works
@@ -25,3 +28,27 @@ This relies on two somewhat obscure Python features:
`demo1` takes advantage of a third obscure feature: the `pkgutil`
library's ability to load data files via the `import` system.
+
+Usage
+-----
+
+This is what `pyzipper --help` returns as of this writing. The
+program itself is authoritative, this is just a snapshot for
+convenience.
+
+```
+usage: pyzipper [-h] -o OUTPUT [-m MODULE] [-e EXECUTABLE] source
+
+Generate an executable Python zip package.
+
+positional arguments:
+ source
+
+optional arguments:
+ -h, --help show this help message and exit
+ -o OUTPUT, --output OUTPUT
+ -m MODULE, --module MODULE
+ module within package to run (default: main)
+ -e EXECUTABLE, --executable EXECUTABLE
+ python executable to run (default: python)
+```