aboutsummaryrefslogtreecommitdiff
path: root/zkvms/zkm/sdk/README.md
diff options
context:
space:
mode:
authorKamen Mladenov <kamen@syndamia.com>2025-02-10 14:29:15 +0200
committerKamen Mladenov <kamen@syndamia.com>2025-02-10 14:29:15 +0200
commit1cb88615eaa0b6a37d42d99c59ad1e23c5d5aa7a (patch)
tree55944e6d38a0e4b717577c74632cafd649cc6994 /zkvms/zkm/sdk/README.md
parent10fb5333c341445303205bc25fb121630a99b27b (diff)
downloadzkVMs-benchmarks-1cb88615eaa0b6a37d42d99c59ad1e23c5d5aa7a.tar
zkVMs-benchmarks-1cb88615eaa0b6a37d42d99c59ad1e23c5d5aa7a.tar.gz
zkVMs-benchmarks-1cb88615eaa0b6a37d42d99c59ad1e23c5d5aa7a.zip
docs(zkvms/zkm): Add detailed documentation comments
Diffstat (limited to 'zkvms/zkm/sdk/README.md')
-rw-r--r--zkvms/zkm/sdk/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/zkvms/zkm/sdk/README.md b/zkvms/zkm/sdk/README.md
index 492fc01..182111b 100644
--- a/zkvms/zkm/sdk/README.md
+++ b/zkvms/zkm/sdk/README.md
@@ -1,3 +1,8 @@
+This is a copy of [ZKM's project SDK](https://github.com/zkMIPS/zkm-project-template/tree/main/sdk), which changes the zkVM cargo dependencies to point to `/nix/store`.
+It is also used as a convinent place which stores the SDK's `libsnark` (`sdk/src/local/libsnark`), so during compilation it is not fetched from the source repo (refer to `zkvms/zkm/default.nix`).
+
+---
+
# ZKM SDK usage
## Use the libsnark