Skip to content

Commit

Permalink
docs: update @aztec/builder readme (#6115)
Browse files Browse the repository at this point in the history
Update README for @aztec/builder to match its current level of
functionality
  • Loading branch information
alexghr authored May 1, 2024
1 parent 4a49f9d commit 248761e
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions yarn-project/builder/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,20 @@
# Aztec.nr compiler
# Aztec builder

The Aztec.nr compiler compiles Aztec.nr contracts using nargo and outputs Aztec formatted contract ABIs.
The compiler can also generate typescript classes for each contract, as well as Aztec.nr interfaces for calling external functions.
The Aztec builder generates typescript classes for Noir contract, as well as Aztec.nr interfaces for calling external functions.
It can also be used to update aztec project dependencies.

## Installation

To install the package, run:
To install the package, run:

```bash
yarn add @aztec/builder
```

## Usage

To run the compiler as a CLI tool, first install the package and then run:
To run the tool, first install the package and then run:

```bash
yarn aztec-builder compile --help
yarn aztec-builder --help
```

You can also run the compiler from the [main Aztec CLI](../cli/README.md), which includes several other features for interacting with the Aztec Network:

```bash
yarn add @aztec/cli
yarn aztec-cli compile --help
```

0 comments on commit 248761e

Please sign in to comment.