Merge pull request #182 from a6-dou/patch-1

(docs): circom install directory note
iden3 · Jan 11, 2024 · 424abce · 424abce
2 parents 96dafc6 + 7af76aa
commit 424abce
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/mkdocs/docs/circom-language/custom-templates-snarkjs.md b/mkdocs/docs/circom-language/custom-templates-snarkjs.md
@@ -1,6 +1,6 @@
 # Custom templates in [snarkjs](../index.md#snarkjs)
 
-[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.
+[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.
 
 ## List of custom gates implemented in snarkjs
 At the moment there are no custom gates implemented in snarkjs yet.
diff --git a/mkdocs/docs/getting-started/installation.md b/mkdocs/docs/getting-started/installation.md
@@ -47,7 +47,7 @@ cargo build --release
 
 The installation takes around 3 minutes to be completed.
 When the command successfully finishes, it generates the `circom` binary in the directory `target/release`. 
-You can install this binary as follows:
+You can install this binary as follows (**Note**: Make sure you're still in the circom directory when running this command) :
 
 ```text
 cargo install --path circom