Skip to content

Commit b4ced6e

Browse files
committed
doc: udpate readme
1 parent 36c2c21 commit b4ced6e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,19 @@
6767

6868
All tasks related to the Semaphore Rust implementation are public. You can track their progress, statuses, and additional details in the [Semaphore Rust view](https://github.com/orgs/semaphore-protocol/projects/10/views/29).
6969

70+
71+
72+
## 🛠 Install
73+
74+
Clone this repository:
75+
76+
```bash
77+
git clone [email protected]:semaphore-protocol/semaphore-rs.git
78+
```
79+
80+
Semaphore uses `Circom-Prover` to generate zero-knowledge proofs for `Circom` circuits. Since `Circom-Prover` generates the witness function at build time, developers must specify the Merkle tree depth during compilation. This can be done by setting the `SEMAPHORE_DEPTH` environment variable:
81+
82+
```bash
83+
cd semaphore-rs
84+
SEMAPHORE_DEPTH=<tree depth> cargo build
85+
```

0 commit comments

Comments
 (0)