From 1cb88615eaa0b6a37d42d99c59ad1e23c5d5aa7a Mon Sep 17 00:00:00 2001 From: Kamen Mladenov Date: Mon, 10 Feb 2025 14:29:15 +0200 Subject: docs(zkvms/zkm): Add detailed documentation comments --- zkvms/zkm/sdk/README.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'zkvms/zkm/sdk') 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 -- cgit v1.2.3