docs: add Windows + Docker installation guide for OpenROAD#4031
docs: add Windows + Docker installation guide for OpenROAD#4031Divinesoumyadip wants to merge 2 commits intoThe-OpenROAD-Project:masterfrom
Conversation
Signed-off-by: Divinesoumyadip <soumyacode7@gmail.com>
Signed-off-by: Divinesoumyadip <soumyacode7@gmail.com>
|
@maliberty @luarss could you approve the workflows to run CI? Happy to address any review feedback. |
luarss
left a comment
luarss
left a comment
There was a problem hiding this comment.
Do add some clarification how these installation instructions are supposed to work. Even better if there are some screenshots
|
|
||
| Run before any apt-get: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Where are you running these commands? Powershell? WSL?
|
|
||
| ## Step 1 — Install and Configure Docker Desktop | ||
|
|
||
| 1. Install Docker Desktop with WSL 2 backend enabled |
There was a problem hiding this comment.
May be a good idea to offload these to a site that shows how to configure these settings, or add some gifs
| Verify installation: | ||
|
|
||
| ``` | ||
| docker run hello-world |
There was a problem hiding this comment.
| docker run hello-world | |
| docker run --rm hello-world |
|
|
||
| ## Step 2 — Avoid Timezone Prompt | ||
|
|
||
| Run before any apt-get: |
There was a problem hiding this comment.
where would one be running these commands? powershell? wsl? might be helpful to pretend that you are following the tutorial when writing these instructions
| ## Step 3 — Install Correct Yosys Version | ||
|
|
||
| ``` | ||
| wget https://github.com/YosysHQ/oss-cad-suite-build/releases/latest/download/oss-cad-suite-linux-x64.tgz |
There was a problem hiding this comment.
Be careful - ORFS does not natively support latest. we usually peg it to a version
|
|
||
| ## Optional: WSL2 Native Build | ||
|
|
||
| See: BuildWithWSL.md in repository |
|
|
||
| Slow performance: | ||
| Use WSL path: | ||
| \\wsl$\Ubuntu\ |
There was a problem hiding this comment.
commands/path to be enclosed in ``` please
| CRLF issue: | ||
|
|
||
| ``` | ||
| git config --global core.autocrlf false |
|
@luarss I opened the original issue #4025 after going through this installation myself on Windows. A few things from my experience that might be worth adding: the yosys version should be pinned (e.g. 2025-03-01) not latest, and it's important to mention git checkout 26Q1 to match the ORFS version with the OpenROAD binary. Happy to contribute these additions! |
|
@agarwaldisha7616 You are welcome to collaborate with @Divinesoumyadip on this branch. No point starting a new PR since there's this one already in-progress. |
3 participants
Closes #4025
Adds docs/user/WindowsDocker.md covering OpenROAD installation on Windows
using Docker Desktop. Addresses all issues reported in #4025.
Issues covered: