Skip to content

Commit

Permalink
docs: updated noirup command (#2339)
Browse files Browse the repository at this point in the history
`noirup` now uses sandbox compatible nargo version in docs.
  • Loading branch information
benesjan authored Sep 19, 2023
1 parent d37eb38 commit 5308c21
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ To build the C++ code, follow the [instructions in the circuits subdirectory](./

To build Typescript code, make sure to have [`nvm`](https://github.com/nvm-sh/nvm) (node version manager) installed.

To build noir code, make sure that you are using the `aztec` tagged version of nargo. This is the latest pin version the team works on to ensure local and ci environments are in sync. This should be installed through `noir-contracts/bootstrap.sh` and the regular `bootstrap.sh` script. However if you find yourself wanting to update to the latest `aztec` tag outside of these channels, you can run `noirup -v aztec` to manually download the latest binaries.
To build noir code, make sure that you are using the version from `yarn-project/noir-compiler/src/noir-version.json`.
Install nargo by running `noirup -v TAG_FROM_THE_FILE`.

## Continuous Integration

Expand Down
7 changes: 6 additions & 1 deletion yarn-project/aztec-nr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,12 @@ To use `Aztec-nr` the `aztec` version of `Noir` is required (Note; this version

Once noirup is installed, you can run the following:
```bash
noirup -v aztec
noirup -v NARGO_VERSION_COMPATIBLE_WITH_YOUR_SANDBOX
```

Replace `NARGO_VERSION_COMPATIBLE_WITH_YOUR_SANDBOX` with the version from the output of `aztec-cli get-node-info`:
```bash
aztec-cli get-node-info
```

For more installation options, please view [Noir's getting started.](https://noir-lang.org/getting_started/nargo_installation)
Expand Down

0 comments on commit 5308c21

Please sign in to comment.