From 111a2cfc4ce8698941f9b54fbe005ba5f366df24 Mon Sep 17 00:00:00 2001 From: Albert Rubio <34064782+alrubio@users.noreply.github.com> Date: Fri, 12 Jan 2024 18:15:00 +0100 Subject: [PATCH] Update the description of the help option --- .../getting-started/compiling-circuits.md | 41 +++++++++++-------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/mkdocs/docs/getting-started/compiling-circuits.md b/mkdocs/docs/getting-started/compiling-circuits.md index c49a2c583..e08bcb9f4 100644 --- a/mkdocs/docs/getting-started/compiling-circuits.md +++ b/mkdocs/docs/getting-started/compiling-circuits.md @@ -11,29 +11,38 @@ Once you have the compiler installed you can see the available options as follow ```console circom --help - Circom Compiler 2.0 + circom compiler 2.1.7 IDEN3 Compiler for the Circom programming language USAGE: - circom [FLAGS] [OPTIONS] [input] + circom [FLAGS] [OPTIONS] [input] FLAGS: - -h, --help Prints help information - --inspect Does an additional check over the constraints produced - --O0 No simplification is applied - -c, --c Compiles the circuit to c - --json outputs the constraints in json format - --r1cs outputs the constraints in r1cs format - --sym outputs witness in sym format - --wasm Compiles the circuit to wasm - --wat Compiles the circuit to wat - --O1 Only applies var to var and var to constant simplification - -V, --version Prints version information + --r1cs Outputs the constraints in r1cs format + --sym Outputs witness in sym format + --wasm Compiles the circuit to wasm + --json Outputs the constraints in json format + --wat Compiles the circuit to wat + -c, --c Compiles the circuit to c + --O0 No simplification is applied + --O1 Only applies var to var and var to constant simplification + --O2 Full constraint simplification + --verbose Shows logs during compilation + --inspect Does an additional check over the constraints produced + --use_old_simplification_heuristics Applies the old version of the heuristics when performing linear + simplification + --simplification_substitution Outputs the substitution in json format + -h, --help Prints help information + -V, --version Prints version information OPTIONS: - --O2 Full constraint simplification [default: full] - -o, --output Path to the directory where the output will be written [default: .] + -o, --output Path to the directory where the output will be written [default: .] + -p, --prime To choose the prime number to use to generate the circuit. Receives the + name of the curve (bn128, bls12381, goldilocks, grumpkin, pallas, vesta) + [default: bn128] + -l ... Adds directory to library search path + --O2round Maximum number of rounds of the simplification process ARGS: Path to a circuit with a main component [default: ./circuit.circom] @@ -74,4 +83,4 @@ With these options we generate three types of files: We can use the option `-o` to specify the directory where these files are created. -Since version 2.0.8, we can use the option `-l` to indicate the directory where the directive `include` should look for the circuits indicated. \ No newline at end of file +Since version 2.0.8, we can use the option `-l` to indicate the directory where the directive `include` should look for the circuits indicated.