diff --git a/CHANGELOG.md b/CHANGELOG.md index 562ee284..2568fd6d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## Unreleased +### Changed +- Complete revamp of script generation, now using templates. Script formats are homogenized and custom templates are enabled. ## 0.27.3 - 2023-09-12 ### Added diff --git a/README.md b/README.md index 3bfc9bba..af175b19 100644 --- a/README.md +++ b/README.md @@ -412,7 +412,7 @@ The `bender config` command prints the currently active configuration as JSON to ### `script` --- Generate tool-specific scripts -The `bender script ` command can generate scripts to feed the source code of a package and its dependencies into a vendor tool. +The `bender script ` 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. Supported formats: @@ -421,10 +421,14 @@ Supported formats: - `vcs`: A Tcl compilation script for VCS. - `verilator`: Command line arguments for Verilator. - `synopsys`: A Tcl compilation script for Synopsys DC and DE. +- `formality`: A Tcl compilation script for Formality (as reference design). - `riviera`: A Tcl compilation script for Aldec Riviera-PRO. - `genus`: A Tcl compilation script for Cadence Genus. - `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. Furthermore, similar flags to the `sources` command exist.