summaryrefslogtreecommitdiff
path: root/examples/features/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/features/README')
-rw-r--r--examples/features/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/examples/features/README b/examples/features/README
new file mode 100644
index 0000000..fc30a53
--- /dev/null
+++ b/examples/features/README
@@ -0,0 +1,21 @@
+This example shows how to use various features of the CLI language.
+
+The example consists of the following files:
+
+options.cli
+ Options class definition in the CLI language.
+
+options.hxx
+options.ixx
+options.cxx
+ Options class implementation in C++. These files are generated by the CLI
+ compiler from hello.cli using the following command line:
+
+ cli options.cli
+
+driver.cxx
+ Driver for the example. It first instantiates the option class which parses
+ the command line. The driver then examines and prints the options values.
+
+To run the example you can try various command lines suggested in the
+options.cli file.