From 8caed382448fea04124ebd2265ecdc1f5bcf82be Mon Sep 17 00:00:00 2001
From: Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com>
Date: Wed, 12 Feb 2025 12:47:20 -0500
Subject: Add some basic documentation for ZJIT

---
 doc/zjit.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'doc')

diff --git a/doc/zjit.md b/doc/zjit.md
index e69de29bb2..7af7fadfa2 100644
--- a/doc/zjit.md
+++ b/doc/zjit.md
@@ -0,0 +1,28 @@
+# ZJIT: ADVANCED RUBY JIT PROTOTYPE
+
+## Build Instructions
+
+To build ZJIT on macOS:
+```
+./autogen.sh
+./configure --disable-yjit --enable-zjit=dev --prefix=$HOME/.rubies/ruby-yjit --disable-install-doc --with-opt-dir="$(brew --prefix openssl):$(brew --prefix readline):$(brew --prefix libyaml)"
+make -j miniruby
+```
+
+To run tests:
+```
+# You'll need to `brew install cargo-nextest` first:
+make zjit-test
+```
+
+## Useful dev commands
+
+To view YARV output for code snippets:
+```
+./miniruby --dump=insns --e0
+```
+
+To run code snippets with ZJIT:
+```
+./miniruby --zjit --e0
+```
-- 
cgit v1.2.3