summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorThomas Waldmann <tw AT waldmann-edv DOT de>2011-03-26 22:45:34 +0100
committerThomas Waldmann <tw AT waldmann-edv DOT de>2011-03-26 22:45:34 +0100
commit5b71d07d11a85bda297f75ca0a255aba5ce968ee (patch)
tree6a557d4875e1a798e09fca98c50caae8ef8486ac /README.txt
parent557cd92bc3ab8a86733a67ac9bf51398a28a8b6f (diff)
downloadargparse-5b71d07d11a85bda297f75ca0a255aba5ce968ee.tar.gz
add a new README.txt and LICENSE.txt
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..e524c1b
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,15 @@
+The argparse module makes it easy to write user friendly command line
+interfaces.
+
+The program defines what arguments it requires, and argparse will figure out
+how to parse those out of sys.argv. The argparse module also automatically
+generates help and usage messages and issues errors when users give the
+program invalid arguments.
+
+As of Python >= 2.7, the argparse module is maintained within the Python
+standard library. For users who still need to support Python < 2.7, it is
+also provided as a separate package, which tries to stay compatible with the
+module in the standard library, but also supports older Python versions.
+
+argparse is licensed under the Python license, for details see LICENSE.txt.
+