From ee565ffaef888237a18a9dd2d4cd52688b0e353b Mon Sep 17 00:00:00 2001 From: Jaremy Creechley Date: Mon, 20 Nov 2023 22:48:54 -0700 Subject: [PATCH] add readme --- example/circom_build/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 example/circom_build/README.md diff --git a/example/circom_build/README.md b/example/circom_build/README.md new file mode 100644 index 0000000..214e074 --- /dev/null +++ b/example/circom_build/README.md @@ -0,0 +1,13 @@ +# Compile Example + +This folder uses modified `fr` files from [witnesscalc](https://github.com/0xPolygonID/witnesscalc). These files modify the Circom generated circutes to support compilation on ARM64. This involves adding a `fr_raw_arm64.s` and `fr_raw_generic` to implement the required `fr` operations. It also changes some types to signed/unsigned to match the ARM versions. + +Requires `gmp` and `nlohmann-json` to be installed and usable from `pkg-config`. On macos you can install them using: `brew install gmp nlohmann-json`. + +To build: + +```sh +cd example/circom_build/ +nim cpp product.nim +./product +```