Skip to content

Commit

Permalink
README.md: Update tera link and script flist command description (#…
Browse files Browse the repository at this point in the history
…178)

* README.md: Add `flist-plus` and update `flist` description

* README.md: Update link to `tera` documentation
  • Loading branch information
colluca authored Aug 21, 2024
1 parent 9eb04ee commit 779d524
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,11 +413,12 @@ The `bender config` command prints the currently active configuration as JSON to

### `script` --- Generate tool-specific scripts

The `bender script <format>` command can generate scripts to feed the source code of a package and its dependencies into a vendor tool. These scripts are rendered using internally stored templates with the [tera](https://tera.netlify.app/) crate, but custom templates can also be used.
The `bender script <format>` command can generate scripts to feed the source code of a package and its dependencies into a vendor tool. These scripts are rendered using internally stored templates with the [tera](https://keats.github.io/tera/docs/) crate, but custom templates can also be used.

Supported formats:

- `flist`: A flat file list amenable to be directly inlined into the invocation command of a tool, e.g. `verilate $(bender script flist)`.
- `flist`: A flat whitespace-separated file list.
- `flist-plus`: A flat file list amenable to be directly inlined into the invocation command of a tool, e.g. `verilate $(bender script flist)`.
- `vsim`: A Tcl compilation script for Mentor ModelSim/QuestaSim.
- `vcs`: A Tcl compilation script for VCS.
- `verilator`: Command line arguments for Verilator.
Expand All @@ -428,8 +429,8 @@ Supported formats:
- `vivado`: A Tcl file addition script for Xilinx Vivado.
- `vivado-sim`: Same as `vivado`, but specifically for simulation targets.
- `precision`: A Tcl compilation script for Mentor Precision.
- `template`: A custom [tera](https://tera.netlify.app/) template, provided using the `--template` flag.
- `template_json`: The json struct used to render the [tera](https://tera.netlify.app/) template.
- `template`: A custom [tera](https://keats.github.io/tera/docs/) template, provided using the `--template` flag.
- `template_json`: The json struct used to render the [tera](https://keats.github.io/tera/docs/) template.

Furthermore, similar flags to the `sources` command exist.

Expand Down

0 comments on commit 779d524

Please sign in to comment.