Skip to content

Commit 424abce

Browse files
authored
Merge pull request iden3#182 from a6-dou/patch-1
(docs): circom install directory note
2 parents 96dafc6 + 7af76aa commit 424abce

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Custom templates in [snarkjs](../index.md#snarkjs)
22

3-
[snarkjs](https://github.com/iden3/snarkjs) provides an implementation of the PLONK's zkSNARK. An extension of the scheme, [turbo-PLONK](https://docs.zkproof.org/pages/standards/accepted-workshop3/proposal-turbo_plonk.pdf), allows the definition of the so called custom gates: more general transition gates than the ones defined by default for the regular PLONK zkSNARK, that allows the circuit's designer to, maybe, reduce the number of used gates, probably resulting in shorter proofs size or verification times. This document will contain a list of the custom gates implemented in snarkjs that can me used in the circom language. Note that the list may grow over time with the new implementations from the iden3 collaborators or thanks to contributions from the community.
3+
[snarkjs](https://github.com/iden3/snarkjs) provides an implementation of the PLONK's zkSNARK. An extension of the scheme, [turbo-PLONK](https://docs.zkproof.org/pages/standards/accepted-workshop3/proposal-turbo_plonk.pdf), allows the definition of the so called custom gates: more general transition gates than the ones defined by default for the regular PLONK zkSNARK, that allows the circuit's designer to, maybe, reduce the number of used gates, probably resulting in shorter proofs size or verification times. This document will contain a list of the custom gates implemented in snarkjs that can be used in the circom language. Note that the list may grow over time with the new implementations from the iden3 collaborators or thanks to contributions from the community.
44

55
## List of custom gates implemented in snarkjs
66
At the moment there are no custom gates implemented in snarkjs yet.

mkdocs/docs/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ cargo build --release
4747

4848
The installation takes around 3 minutes to be completed.
4949
When the command successfully finishes, it generates the `circom` binary in the directory `target/release`.
50-
You can install this binary as follows:
50+
You can install this binary as follows (**Note**: Make sure you're still in the circom directory when running this command) :
5151

5252
```text
5353
cargo install --path circom

0 commit comments

Comments
 (0)