Skip to content

Commit a744321

Browse files
jzakiTomAFrench
andauthored
docs: Update installation info for bb and noir (#8119)
People trip up on not having jq installed when noir instructions tell them to use the bb command. Update both to smooth this out. --------- Co-authored-by: Tom French <[email protected]>
1 parent 048fa12 commit a744321

File tree

1 file changed

+6
-3
lines changed
  • barretenberg/cpp/src/barretenberg/bb

1 file changed

+6
-3
lines changed

barretenberg/cpp/src/barretenberg/bb/readme.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
### Why is this needed?
44

55
Barretenberg is a library that allows one to create and verify proofs. One way to specify the circuit that one will use to create and verify
6-
proofs over is to use the Barretenberg standard library. Another way, which pertains to this module is to supply the circuit description using
7-
an IR called [ACIR](https://github.com/noir-lang/acvm).
6+
proofs over is to use the Barretenberg standard library. Another way, which pertains to this module is to supply the circuit description using an IR called [ACIR](https://github.com/noir-lang/acvm).
87

98
This binary will take as input ACIR and witness values described in the IR to create proofs.
109

@@ -35,7 +34,7 @@ This binary will take as input ACIR and witness values described in the IR to cr
3534
```
3635

3736
Check the version compatibility section below for how to identify matching versions.
38-
37+
3938
4. Check if the installation was successful:
4039

4140
```bash
@@ -44,6 +43,10 @@ This binary will take as input ACIR and witness values described in the IR to cr
4443

4544
If installation was successful, the command would print the version of `bb` installed.
4645

46+
### Usage prerequisites
47+
48+
Certain `bb` commands will expect the tool `jq` to already be installed. If `jq -V` doesn't return a version number, install it from [here](https://jqlang.github.io/jq/download/).
49+
4750
### Version compatibility with Noir
4851
4952
TODO: https://github.com/AztecProtocol/aztec-packages/issues/7511

0 commit comments

Comments
 (0)