summary refs log tree commit diff stats
path: root/examples/cross_calculator/nimrod_commandline/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cross_calculator/nimrod_commandline/readme.txt')
-rw-r--r--examples/cross_calculator/nimrod_commandline/readme.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/examples/cross_calculator/nimrod_commandline/readme.txt b/examples/cross_calculator/nimrod_commandline/readme.txt
new file mode 100644
index 000000000..45c1a30af
--- /dev/null
+++ b/examples/cross_calculator/nimrod_commandline/readme.txt
@@ -0,0 +1,9 @@
+In this directory you will find the nimrod 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, just include the path to the backend in your
+compilation command. A basic build.sh is provided for unix like platforms with
+the correct parameters.