Skip to content

Commit f5e304e

Browse files
Automated documentation update [skip ci]
1 parent 8c4fe3c commit f5e304e

File tree

2 files changed

+24
-20
lines changed

2 files changed

+24
-20
lines changed

src/barretenberg/README.md

100755100644
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11

2-
# Barretenberg
2+
# Barretenberg (barretenberg)
33

4-
A feature that installs the Barretenberg `cli` tool `bb` and its installer `bbup`.
4+
A feature to install Barretenberg
55

66
## Example Usage
77

8-
You can specify any version of `bb`, or leave empty to match with an existent version of `nargo` on the container.
9-
108
```json
119
"features": {
12-
"ghcr.io/devcontainers/feature/barretenberg:1": {
13-
"version": "0.80.0"
14-
}
10+
"ghcr.io/signorecello/noir-bb-devcontainer-feature/barretenberg:1": {}
1511
}
1612
```
1713

1814
## Options
1915

20-
| Options Id | Description | Type | Default Value |
21-
| ---------- | ---------------------- | ------ | ------------- |
22-
| version | The version to install | string | nargo |
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | The version of Barretenberg to install. Defaults to the latest Nargo compatible version. | string | nargo |
19+
20+
21+
22+
---
23+
24+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/signorecello/noir-bb-devcontainer-feature/blob/main/src/barretenberg/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

src/noir/README.md

100755100644
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11

2-
# Nargo
2+
# Noir (noir)
33

4-
A feature that installs the Nargo `cli` tool `nargo` and its installer `noirup`.
4+
A feature to install Noir
55

66
## Example Usage
77

8-
You can specify any version of `noir`, or leave empty to install the latest stable. Pass `nightly` for the latest nightly version.
9-
108
```json
119
"features": {
12-
"ghcr.io/devcontainers/feature/barretenberg:1": {
13-
"version": "nightly"
14-
}
10+
"ghcr.io/signorecello/noir-bb-devcontainer-feature/noir:1": {}
1511
}
1612
```
1713

1814
## Options
1915

20-
| Options Id | Description | Type | Default Value |
21-
| ---------- | ---------------------- | ------ | ------------- |
22-
| version | The version to install | string | nargo |
16+
| Options Id | Description | Type | Default Value |
17+
|-----|-----|-----|-----|
18+
| version | The version of Noir to install | string | latest |
19+
20+
21+
22+
---
23+
24+
_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/signorecello/noir-bb-devcontainer-feature/blob/main/src/noir/devcontainer-feature.json). Add additional notes to a `NOTES.md`._

0 commit comments

Comments
 (0)