chore: Mention dylib experimental and disable by default

zkmopro · Feb 1, 2024 · e231351 · e231351
1 parent c9f34ad
commit e231351
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ dir = "examples/circom/keccak256" # Directory of the circuit
 name = "keccak256_256_test"       # Name of the circuit
 
 [dylib]
-use_dylib = true         # Options: true, false
+use_dylib = false         # Options: true, false
 name = "keccak256.dylib" # Name of the dylib file, only used if use_dylib is true
 ```
 

diff --git a/config-example.toml b/config-example.toml
@@ -14,5 +14,7 @@ dir = "examples/circom/keccak256" # Directory of the circuit
 name = "keccak256_256_test"       # Name of the circuit
 
 [dylib]
-use_dylib = true         # Options: true, false
+# NOTE: Dylib support is experimental and requires some fiddling in iOS
+# See https://github.com/oskarth/mopro/pull/37 and https://github.com/oskarth/mopro/pull/38
+use_dylib = false        # Options: true, false
 name = "keccak256.dylib" # Name of the dylib file, only used if use_dylib is true