summary refs log tree commit diff stats
path: root/examples/cross_calculator/nim_commandline/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cross_calculator/nim_commandline/readme.txt')
-rw-r--r--examples/cross_calculator/nim_commandline/readme.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/examples/cross_calculator/nim_commandline/readme.txt b/examples/cross_calculator/nim_commandline/readme.txt
new file mode 100644
index 000000000..f95bd962e
--- /dev/null
+++ b/examples/cross_calculator/nim_commandline/readme.txt
@@ -0,0 +1,10 @@
+In this directory you will find the nim commandline version of the
+cross-calculator sample.
+
+The commandline interface can be used non interactively through switches, or
+interactively when running the command without parameters.
+
+Compilation is fairly easy despite having the source split in different
+directories. Thanks to the nim.cfg file, which adds the ../nim_backend
+directory as a search path, you can compile and run the example just fine from
+the command line with 'nim c -r nimcalculator.nim'.