Skip to content

Commit

Permalink
chore(docs): authwit note, not simulating simulations (#9438)
Browse files Browse the repository at this point in the history
Adds notes to the docs that indicate that authwits only work in single
player mode, describes the problems with not simulating simulations, and
updates the bberg readme install instructions

closes AztecProtocol/dev-rel#422
closes AztecProtocol/dev-rel#433
closes AztecProtocol/aztec-packages#9256
closes AztecProtocol/dev-rel#423
closes AztecProtocol/aztec-packages#6865
  • Loading branch information
critesjosh authored and AztecBot committed Nov 6, 2024
1 parent 0e27d08 commit 6909bfd
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
</p>
</div>


# Aztec.nr

`Aztec-nr` is a [Noir](https://noir-lang.org) framework for smart contracts on [Aztec](aztec.network).

### Directory Structure

```
.
├── aztec // The core of the aztec framework
Expand All @@ -47,24 +47,26 @@ easy_private_state = { git = "https://github.com/AztecProtocol/aztec-nr", tag =
value_note = { git = "https://github.com/AztecProtocol/aztec-nr", tag = "master" , directory = "value-note" }
```


## Prerequisites

To use `Aztec.nr` you must have [Noir](https://noir-lang.org/) installed. Noir is a general purpose programming language for creating zero-knowledge-proofs. `Aztec.nr` supercharges the Noir language with Aztec Smart Contract capabilities.

### Quick Installation
The fastest way to install is with [noirup](https://noir-lang.org/docs/getting_started/installation/#installing-noirup).

The fastest way to install is with [noirup](https://noir-lang.org/docs/getting_started/quick_start).

To use `Aztec-nr` the `aztec` version of `Noir` is required (Note; this version is temporarily required if you would like to use `#[aztec()]` macros).

Once noirup is installed, you can run the following:

```bash
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/docs/getting_started/installation/other_install_methods)

0 comments on commit 6909bfd

Please sign in to comment.