From 82d931a01ff6d60b9584871888ea0105eb49a48e Mon Sep 17 00:00:00 2001 From: Johannes Schmitz Date: Mon, 11 Feb 2019 13:35:08 +0100 Subject: [PATCH] Clarify description of "usage string" feature in README --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e35e1cc..8c5e7ca 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,10 @@ that can be converted from a string using `std::ostream`. `Arg`s specify arguments that are not tied to options, and so have no square bracket names. They otherwise work just like `Opt`s. -A, console optimised, usage string can be obtained by inserting the parser into a stream. +A, console optimised, usage string can be obtained by inserting the parser into an output stream like this: +``` +std::cout << cli << std::endl; +``` The usage string is built from the information supplied and is formatted for the console width. As a convenience, the standard help options (`-h`, `--help` and `-?`) can be specified using the `Help` parser,