From 67423cfffb0da682f2df310db82cef5cfbdcfe80 Mon Sep 17 00:00:00 2001
From: oskarth <oskarth@titanproxy.com>
Date: Sat, 11 Nov 2023 20:30:17 +0300
Subject: [PATCH] docs(core,ark-zkey): Instructions for how to generate arkzkey

---
 ark-zkey/README.md   | 14 ++++++++++++++
 mopro-core/README.md |  4 ++++
 2 files changed, 18 insertions(+)

diff --git a/ark-zkey/README.md b/ark-zkey/README.md
index 93ea89d7..8034b008 100644
--- a/ark-zkey/README.md
+++ b/ark-zkey/README.md
@@ -4,6 +4,20 @@ Library to read `zkey` faster by serializing to `arkworks` friendly format.
 
 See https://github.com/oskarth/mopro/issues/25 for context.
 
+## To generate arkzkey
+
+Hacky, but the way we generate `arkzkey` now is by running the corresponding test.
+
+E.g.:
+
+```
+cargo test multiplier2 --release -- --nocapture
+cargo test keccak256 --release -- --nocapture
+cargo test rsa --release -- --nocapture
+```
+
+Will take corresponding `zkey` and put `arkzkey`` in same folder.
+
 ## Multiplier
 
 NOTE: Need to change const ZKEY here
diff --git a/mopro-core/README.md b/mopro-core/README.md
index 01b4f37d..52a229a6 100644
--- a/mopro-core/README.md
+++ b/mopro-core/README.md
@@ -33,3 +33,7 @@ Note that:
 - It has to be built for the right architecture
 - Have to run `install_name_tool` to adjust install name
 - Run `codesign` to sign dylib for use on iOS
+
+## To use ark-zkey
+
+Experimental support for significantly faster zkey loading. See `../ark-zkey` README for how to build arkzkey.
\ No newline at end of file