From 1af327d35355839e680cd60d043606d6f640fc43 Mon Sep 17 00:00:00 2001
From: Reuben Dunnington <reuben.dunnington@gmail.com>
Date: Mon, 25 Sep 2023 22:07:46 -0400
Subject: [PATCH] zig-sample: add README

---
 samples/zig-sample/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 samples/zig-sample/README.md

diff --git a/samples/zig-sample/README.md b/samples/zig-sample/README.md
new file mode 100644
index 0000000..51ac4f2
--- /dev/null
+++ b/samples/zig-sample/README.md
@@ -0,0 +1,16 @@
+### Build and run
+Zig version `0.11.0` or greater is required for this sample. To build and run:
+```
+orca dev build-runtime
+zig build run
+```
+
+These two commands build the runtime - the native host executable - and the sample as a loadable wasm library, then runs it. To only build the sample without running it, use `zig build bundle`.
+
+### Warning
+Zig integration is still in-progress and experimental. You may encounter bugs since not all the bound APIs have been tested extensively - this sample is currently the only code doing so! Additionally, not all APIs have zig coverage yet, notably:
+* `oc_str8`, `oc_str16`, `oc_str32`: partial coverage
+* `oc_ui`: none
+* `gles`: none
+
+Please report any bugs you find on the Handmade discord in the #orca channel.