aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTaylor C. Richberger <Taywee@gmx.com>2016-05-05 15:45:47 -0600
committerTaylor C. Richberger <Taywee@gmx.com>2016-05-05 15:45:47 -0600
commitcdc659399059db5d39ef571b72abf90128b65f47 (patch)
tree0ebbf4d0d1d79b0cc372365ee66701ee2894a494 /README.md
parentimprove doxygenation (diff)
downloadargs.hxx-cdc659399059db5d39ef571b72abf90128b65f47.tar.xz
improve documentation, doxygenate code fully
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/README.md b/README.md
index 97038e4..2ed7291 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# args
-A simple, small, flexible, single-header C++11 argument parsing library
+
+A simple, small, flexible, single-header C++11 argument parsing library, in
+fewer than 1024 lines of code.
This is designed to somewhat replicate the behavior of Python's argparse, but
in C++, with static type checking, and hopefully a lot faster.
@@ -43,13 +45,6 @@ There are tons of things this library does not do!
## It does not yet:
-* Allow you to use a positional argument list before any other positional
- arguments (the last argument list will slurp all subsequent positional
- arguments). The logic for allowing this would be a lot more code than I'd
- like, and would make static checking much more difficult, requiring us to
- sort std::string arguments and pair them to positional arguments before
- assigning them, rather than what we currently do, which is assiging them as
- we go for better simplicity and speed.
* Let you decide not to allow separate-argument argument flags or joined ones
(like disallowing `--foo bar`, requiring `--foo=bar`, or the inverse, or the
same for short options).
@@ -64,6 +59,14 @@ There are tons of things this library does not do!
* Allow you to intermix multiple different prefix types (eg. `++foo` and
`--foo` in the same parser), though shortopt and longopt prefixes can be
different.
+* Allow you to have argument flags only optionally accept arguments
+* Allow you to use a positional argument list before any other positional
+ arguments (the last argument list will slurp all subsequent positional
+ arguments). The logic for allowing this would be a lot more code than I'd
+ like, and would make static checking much more difficult, requiring us to
+ sort std::string arguments and pair them to positional arguments before
+ assigning them, rather than what we currently do, which is assiging them as
+ we go for better simplicity and speed.
# How do I use it?