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 @aztec/builder readme #6115

Merged
merged 1 commit into from
May 1, 2024
Merged

docs: update @aztec/builder readme #6115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 5 additions & 13 deletions yarn-project/builder/README.md
View file
Open in desktop
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
```
Loading