-
Notifications
You must be signed in to change notification settings - Fork 295
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: document aztec-nargo in readme (#11173)
- Loading branch information
Showing
2 changed files
with
13 additions
and
1 deletion.
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
## `aztec-nargo` | ||
|
||
The `aztec-nargo` utility is packaged with docker and does the following: | ||
1. If the first argument to `aztec-nargo` is not `compile`, it just forwards args to `nargo` and exits. | ||
1. If the first argument _is_ `compile`, it forwards args to `nargo` with some added options (like `--inliner-aggressiveness 0 --show-artifact-paths`) | ||
3. Extracts all artifacts modified by `nargo` | ||
4. Transpiles each artifact using the `avm-transpiler` | ||
5. Generates verification keys for each artifact using `bb` (`barretenberg`'s binary) | ||
|
||
Example usage: `aztec-nargo compile` | ||
|
||
Note: uses versions of each tool from this repository (`nargo` version is from `../noir`). |
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