1 files changed, 37 insertions, 0 deletions
diff --git a/zkvms/zkm/sdk/README.md b/zkvms/zkm/sdk/README.md
new file mode 100644
index 0000000..492fc01
--- /dev/null
+++ b/zkvms/zkm/sdk/README.md
@@ -0,0 +1,37 @@
+# ZKM SDK usage
+
+## Use the libsnark
+
+1. The  compile.sh in the path sdk/src/local/libsnark only supports X86_64 linux.For MacOS, there is a [Dockerfile](../Dockerfile) in the template.
+   
+```
+cd zkm-project-template/sdk/src/local/libsnark
+./compile.sh
+```
+    If successful, it will generate the libsnark.so in sdk/src/local/libsnark/
+
+2. To instruct your Rust environment on the location of the libsnark.so , you can set the LD_LIBRARY_PATH environment variable. For example:
+
+```
+export LD_LIBRARY_PATH=Your BASEDIR/zkm-project-template/sdk/src/local/libsnark:$LD_LIBRARY_PATH  
+```
+
+3. Import the SDK
+   
+```
+// Cargo.toml
+[dependencies]
+zkm-sdk = { git = "https://github.com/zkMIPS/zkm-project-template", branch = "main", features = ["snark"] }
+```
+
+## Don't use the libsnark
+
+1. Set the environment variable `NO_USE_SNARK=true` .
+  
+2. Import the SDK
+   
+```
+// Cargo.toml
+[dependencies]
+zkm-sdk = { git = "https://github.com/zkMIPS/zkm-project-template", branch = "main" }
+```