examples/simple: add note in README

au-ts · Sep 23, 2023 · ca7e50c · ca7e50c
1 parent 390c302
commit ca7e50c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/examples/simple/README.md b/examples/simple/README.md
@@ -33,5 +33,9 @@ For educational purposes, you can also build and run this example using the
 You will first need Zig version 0.11.0, which can be downloaded here: [TODO]().
 
 ```sh
+# TODO @ivanv fix this command to also include board
 zig build -Dtarget="aarch64-freestanding" -Doptimize=ReleaseFast simualte
 ```
+
+[A known issue]() is that compiling the example without optimisations does not
+cause the example to function correctly.