about summary refs log tree commit diff stats
path: root/apps
diff options
context:
space:
mode:
Diffstat (limited to 'apps')
-rw-r--r--apps/factorial.mu14
1 files changed, 10 insertions, 4 deletions
diff --git a/apps/factorial.mu b/apps/factorial.mu
index 722c9e6c..83b2bedf 100644
--- a/apps/factorial.mu
+++ b/apps/factorial.mu
@@ -1,7 +1,13 @@
-# usage:
-#   ./translate_mu apps/factorial.mu
-#   ./a.elf test  # to run tests
-#   ./a.elf       # to run factorial(5)
+# compute the factorial of 5, and return the result in the exit code
+#
+# To run:
+#   $ ./translate_mu apps/factorial.mu
+#   $ ./a.elf
+#   $ echo $?
+#   120
+#
+# You can also run the automated test suite:
+#   $ ./a.elf test
 #
 # Compare apps/factorial4.subx