docs: Add a typical invocation example.

[skip ci][skip lemma]
au-ts · Jan 10, 2020 · 00aeb59 · 00aeb59
1 parent bcc9f0e
commit 00aeb59
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/compiler.rst b/docs/compiler.rst
@@ -51,6 +51,14 @@ influencing the compiler's behaviour as it works.
    -O LEVEL, --optimisation=LEVEL  \
        set optimisation level (0, 1, 2, d, n, s or u; default -Od)
 
+.. highlight:: bash
+
+A typical invocation might be::
+
+  $ cogent -g -o generated \
+           --infer-c-funcs=main.ac \
+           --infer-c-types=abstract/Grid.ah \
+           mandelbrot.cogent
 
 Commands
 ^^^^^^^^^^^^^^^^^^^^^^^^