From e024e535cd0b2a908a8c3eda667733d8a49157b1 Mon Sep 17 00:00:00 2001 From: Dayton <5340801+watbulb@users.noreply.github.com> Date: Sun, 8 Sep 2024 16:03:19 -0600 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1804d48..3cd177f 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,19 @@ _Note: Work In Progress, see top of `config.json`_ GDSPY is required to add boundary layers to GDS files: `apt install python3-gdspy` +- First, `git submodule update --init`. - Place your magic art designs in `mag/` or `gds/` -- If your design is a `.mag`, run `make preproc ` +- run `make preproc ` - This will produce GDS/LEF outputs used during a Openlane2 custom flow. - -```bash -git submodule update --init -make preproc ttlogo -make tt_harden_top -``` + - Additionally, a PN boundary layer will be added to any converted GDS or converted MAG during the preproc phase. +- Make a copy of `src/ttlogo_config.json` as `src/_config.json` + - Edit the `VERILOG_DEFINES` and `MACROS` options to specify which macro you would like to place. +- Run `make tt_harden_top ` **Things to be done** -- [ ] (Fix the flow properly stream out the GDS, GDS -> isn't including PR boundary) -- [ ] (Dynamically generate macro inclusions into the config from a macros.cfg) +- [X] (Fix the flow properly stream out the GDS, GDS -> isn't including PR boundary) +- [X] (Make sure we support input mags that have power nets that we will eventually ignore) +- [X] (The PDN config is basically a no-op. we can interleave configs for mags that needs a POWER net) - [ ] (Standardize and document minimal flow required to macro place without detailed or global routing) -- [ ] (Make sure we support input mags that have power nets that we will eventually ignore) -- [ ] (The PDN config is basically a no-op. we can interleave configs for mags that needs a POWER net) +- [ ] (Alow the usage of multiple macros in the blackbox using a generate verilog statement)