Skip to content

Commit

Permalink
Update installation info for bb and noir
Browse files Browse the repository at this point in the history
  • Loading branch information
jzaki committed Aug 21, 2024
1 parent bf38d61 commit fcc7f82
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
8 changes: 6 additions & 2 deletions barretenberg/cpp/src/barretenberg/bb/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +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
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 +35,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 +44,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
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ noirup

Done. That's it. You should have the latest version working. You can check with `nargo --version`.

:::note
Be sure to check the prerequisites for the Noir backend you are using. For instance, those for the default backend `bb` can be found [here](https://github.com/AztecProtocol/aztec-packages/blob/master/barretenberg/cpp/src/barretenberg/bb/readme.md#usage-prerequisites).
:::

You can also install nightlies, specific versions
or branches. Check out the [noirup repository](https://github.com/noir-lang/noirup) for more
information.
Expand Down

0 comments on commit fcc7f82

Please sign in to comment.