summaryrefslogtreecommitdiff
path: root/cli-examples/features/README
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2020-04-08 14:51:57 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2020-04-27 11:38:53 +0300
commit720c5a33b6a49cf328fdd7611f49153cf8f60247 (patch)
tree9725f3d1f42ec90fde84520f49647edea013ce5e /cli-examples/features/README
parent3183f3bb927a90783ae0aeaf190a0919377aabe4 (diff)
Separate tests and examples into individual packages
Also make cli module to be explicitly enabled via the config.cli configuration variable.
Diffstat (limited to 'cli-examples/features/README')
-rw-r--r--cli-examples/features/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/cli-examples/features/README b/cli-examples/features/README
new file mode 100644
index 0000000..9416320
--- /dev/null
+++ b/cli-examples/features/README
@@ -0,0 +1,20 @@
+This example shows how to use various features of the CLI language.
+
+The example consists of the following files:
+
+options.cli
+ Command line interface description in the CLI language.
+
+options.hxx
+options.ixx
+options.cxx
+ Command line interface 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 option values.
+
+To run the example you can try various command lines suggested in options.cli.