summaryrefslogtreecommitdiff
path: root/examples/hello/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/hello/README')
-rw-r--r--examples/hello/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/examples/hello/README b/examples/hello/README
new file mode 100644
index 0000000..a1fe976
--- /dev/null
+++ b/examples/hello/README
@@ -0,0 +1,26 @@
+This is a "Hello, world!" example that shows how to implement a very basic
+command line interface using CLI.
+
+The example consists of the following files:
+
+hello.cli
+ Options class definition in the CLI language.
+
+hello.hxx
+hello.ixx
+hello.cxx
+ Options class implementation in C++. These files are generated by the CLI
+ compiler from hello.cli using the following command line:
+
+ cli hello.cli
+
+driver.cxx
+ Driver for the example. It first instantiates the option class which parses
+ the command line. The driver then examines the options and prints the
+ greeting string for each name passed as argument.
+
+To run the example you can try the following command lines:
+
+$ ./driver --help
+$ ./driver John Jane
+$ ./driver --greeting Hi --exclamations 3 John Jane