summaryrefslogtreecommitdiff
path: root/compiler/cli/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'compiler/cli/README.md')
-rw-r--r--compiler/cli/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/compiler/cli/README.md b/compiler/cli/README.md
new file mode 100644
index 000000000..6095c73bf
--- /dev/null
+++ b/compiler/cli/README.md
@@ -0,0 +1,13 @@
+# cli
+
+`cli` is a CLI (Command Line Interface) application framework.
+
+# Background
+
+Many tools in `nncc` are command-line interface (CLI) applications. They generally need to handle command line parameters.
+`cli` was written to reduce code duplication across such applications.
+
+
+# How to use
+
+Please refer to `cli/src/App.test.cpp` for an example.