commit 54507360a304203783907b52cc824f906ac3d9da
parent cc84490dc9d36dc07b871cc4eb2c6c52daf6e5a8
Author: Walther Chen <walther.chen@gmail.com>
Date: Wed, 9 Nov 2022 23:48:14 -0500
update readme
Diffstat:
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -2,6 +2,23 @@ bf interpreter.
following: https://eli.thegreenplace.net/2017/adventures-in-jit-compilation-part-1-an-interpreter/
-using: zig nightly (0.11.0-dev.48+678f3f6e6)
+using: zig nightly (0.11.0-dev.48+678f3f6e6), download zig at https://ziglang.org/download/ . Other versions may work, no guarantees.
-Note: to run `fixtures/factor.zig`, overflow must be allowed. So -Drelease-fast removes the check.
+Note: to run `fixtures/factor.bf`, overflow must be allowed, so build w/ `-Drelease-fast`.
+
+## usage
+
+stages:
+- og (original)
+- opt1 (optimized 1)
+- ...
+
+```
+zig build <stage> -Drelease-fast -- <bf-source-file>
+```
+
+There's also a flag to enable tracing `-Dtrace`, and some fixtures to try in `./fixtures`. So one example run would be:
+
+```
+zig build opt1 -Drelease-fast -Dtrace -- fixtures/mandelbrot.bf
+```
