aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-11-28 00:35:42 +0100
committerMattias Andrée <maandree@operamail.com>2015-11-28 00:35:42 +0100
commit11a60557455650b7a3935afd4000cf69cc403b08 (patch)
tree93bb0eb877a2e67c5985d8bdd66186f092cc9fd8
parentfix va_copy use (diff)
downloadargparser-11a60557455650b7a3935afd4000cf69cc403b08.tar.gz
argparser-11a60557455650b7a3935afd4000cf69cc403b08.tar.bz2
argparser-11a60557455650b7a3935afd4000cf69cc403b08.tar.xz
improve readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--README27
1 files changed, 21 insertions, 6 deletions
diff --git a/README b/README
index 332cdf4..90b0f2b 100644
--- a/README
+++ b/README
@@ -1,6 +1,21 @@
-Command line option parser library for multiple languages
-with the capability of both - and + short options and
-both -- and ++ long options. It supports variadic options,
-colours, --, temporary -- using ++, stickness configurable
-optionally argumented options, and configurable abbreviations
-that can be used to typo correction if you so wish.
+NAME
+ argparser - Command line argument parser library
+
+DESCRIPTION
+ Command line parser library with support for
+ * coloured help output,
+ * long options,
+ * single dash long options,
+ * plus options,
+ * temporary -- using ++,
+ * variadic options,
+ * optionally argumented options, and
+ * abbreviations, and other user-defined corrections.
+
+RATIONALE
+ We should always strive to make the command line
+ even better.
+
+SEE ALSO
+ getopt(1), getopt(3), getopts(1), info argp
+