Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update installation info for bb and noir #8119

Merged
merged 2 commits into from
Aug 22, 2024
Merged

docs: Update installation info for bb and noir #8119

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a96d4b
Update bb usage prerequisites
jzaki Aug 21, 2024
2087f2c
Update barretenberg/cpp/src/barretenberg/bb/readme.md
TomAFrench Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions barretenberg/cpp/src/barretenberg/bb/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
### Why is this needed?

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
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).
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).

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

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

Check the version compatibility section below for how to identify matching versions.

4. Check if the installation was successful:

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

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

### Usage prerequisites

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/).

### Version compatibility with Noir

TODO: https://github.com/AztecProtocol/aztec-packages/issues/7511
Expand Down
Loading