-
Notifications
You must be signed in to change notification settings - Fork 270
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update @aztec/builder readme (#6115)
Update README for @aztec/builder to match its current level of functionality
- Loading branch information
Showing
1 changed file
with
5 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |