docs: add Docker quickstart for gcd on nangate45#4303
Conversation
Add a short verified walkthrough for the default ORFS smoke test and fix the GDS output path in index.md to include the base flow variant. Signed-off-by: fusang <fusang991@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new Docker-based quickstart guide for running the gcd design on the nangate45 platform, updating the documentation index, table of contents, and tutorial homepage to link to it. The review feedback focuses on correcting corrupted em-dash characters in the text and ensuring that the documented file paths are consistent with the instructed working directory by removing redundant directory prefixes.
| This guide runs the smallest ORFS smoke test �� the `gcd` design on the | ||
| `nangate45` platform �� from RTL to GDS using the pre-built Docker image. |
There was a problem hiding this comment.
The text contains garbled characters (`` or ¡ª) which appear to be a corrupted em-dash. Replacing them with a standard UTF-8 em-dash (`—`) ensures proper rendering across all platforms and browsers.
| This guide runs the smallest ORFS smoke test �� the `gcd` design on the | |
| `nangate45` platform �� from RTL to GDS using the pre-built Docker image. | |
| This guide runs the smallest ORFS smoke test — the `gcd` design on the | |
| `nangate45` platform — from RTL to GDS using the pre-built Docker image. |
| | Artifact | Path | | ||
| |----------|------| | ||
| | GDSII | `flow/results/nangate45/gcd/base/6_final.gds` | | ||
| | DEF | `flow/results/nangate45/gcd/base/6_final.def` | | ||
| | Logs | `flow/logs/nangate45/gcd/base/` | |
There was a problem hiding this comment.
The paths in this table include the flow/ prefix, but the user was instructed to cd flow in the previous section. To avoid confusion and match the ls command on line 60, these paths should be relative to the flow directory.
| | Artifact | Path | | |
| |----------|------| | |
| | GDSII | `flow/results/nangate45/gcd/base/6_final.gds` | | |
| | DEF | `flow/results/nangate45/gcd/base/6_final.def` | | |
| | Logs | `flow/logs/nangate45/gcd/base/` | | |
| | Artifact | Path | | |
| |----------|------| | |
| | GDSII | `results/nangate45/gcd/base/6_final.gds` | | |
| | DEF | `results/nangate45/gcd/base/6_final.def` | | |
| | Logs | `logs/nangate45/gcd/base/` | |
| - Image: `openroad/orfs:latest` | ||
| - Command: `util/docker_shell make DESIGN_CONFIG=./designs/nangate45/gcd/config.mk` | ||
| - Full clean run (`make clean_all` then `make`): ~61 seconds wall time | ||
| - Output: `flow/results/nangate45/gcd/base/6_final.gds` present |
There was a problem hiding this comment.
To maintain consistency with the updated table and the active directory (flow/), the output path here should also omit the flow/ prefix.
| - Output: `flow/results/nangate45/gcd/base/6_final.gds` present | |
| - Output: `results/nangate45/gcd/base/6_final.gds` present |
Use ASCII dashes and paths relative to the flow directory for consistency. Signed-off-by: fusang <fusang991@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
2 participants
Add a short verified walkthrough for the default ORFS smoke test and fix the GDS output path in index.md to include the base flow variant.