Skip to content

docs: point pre-built binary docs to OpenROAD VaultLink #4707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vvbandeira merged 1 commit into from
Oct 20, 2026
Merged

docs: point pre-built binary docs to OpenROAD VaultLink #4707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user/BuildLocally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `setup.sh` script installs all of the dependencies, including OpenROAD dependencies, if they are not already installed.

Supported configurations are: Ubuntu 22.04, Ubuntu 22.04(aarch64), RHEL 8, RockyLinux 9 and Debian 11.
Supported configurations are: Ubuntu 22.04, RHEL 8 and RockyLinux 9.

@gemini-code-assist gemini-code-assist Bot Oct 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Rocky Linux is officially spelled with a space. Let's update "RockyLinux 9" to "Rocky Linux 9" for consistency and correctness.

Suggested change
Supported configurations are: Ubuntu 22.04, RHEL 8 and RockyLinux 9.
Supported configurations are: Ubuntu 22.04, RHEL 8 and Rocky Linux 9.


``` shell
git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts
Expand Down
4 changes: 2 additions & 2 deletions docs/user/BuildWithDocker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ docker run --rm ubuntu:22.04 nproc
### Build Using Docker from pre-built binaries

Courtesy of [Precision Innovations](https://precisioninno.com/),
they release `.deb` installers of OpenROAD for Ubuntu
and Debian on a regular basis.
pre-built `.deb` installers of OpenROAD for Ubuntu
are available from [OpenROAD VaultLink](https://vaultlink.precisioninno.com/).
This greatly helps to reduce the compilation time needed.

We recommend to use a Docker image of a supported OS
Expand Down
20 changes: 8 additions & 12 deletions docs/user/BuildWithPrebuilt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,27 @@ Instructions for installing:
- [Klayout>=0.28.8](https://www.klayout.de/build.html)
- [Yosys>=0.58](https://github.com/YosysHQ/oss-cad-suite-build/blob/master/README.md#installation)

```{tip} Unfortunately KLayout maintainers do not provide Debian 11 compatible packages. You can follow the build-from-sources instruction (Version >=0.25) and Ubuntu 22 instructions [here](https://www.klayout.de/build.html#:~:text=Building%20KLayout%20on%20Linux%20(Version%20%3E%3D%200.25)).
```

## Install OpenROAD
Download pre-built binaries with self-contained dependencies
included from the Precision Innovations' GitHub releases
[here](https://github.com/Precision-Innovations/OpenROAD/releases).
from [OpenROAD VaultLink](https://vaultlink.precisioninno.com/).

Thanks to [Precision Innovations](https://precisioninno.com/) for hosting and maintaining these binaries.

The following platforms are supported currently:
Pre-built binaries are available for these platforms:
- Ubuntu 22.04
- Debian 11
- Ubuntu 24.04

Use the following steps to download:

Step 1: Click on the [Precision Innovations Github releases link](https://github.com/Precision-Innovations/OpenROAD/releases).
Step 1: Open [OpenROAD VaultLink](https://vaultlink.precisioninno.com/).

Step 2: Download the artifacts for your distribution.
Step 2: Download the `.deb` package for your Ubuntu version.

Step 3: Run the install command based on platform use package installer.
For example Ubuntu 22.04 use:
Step 3: Install the package with `apt`.
For example, on Ubuntu 22.04:

```shell
sudo apt install ./openroad_2.0_amd64-ubuntu22.04.deb
sudo apt install ./openroad_<version>_amd64-ubuntu-22.04.deb
```

## Verify Installation
Expand Down
2 changes: 1 addition & 1 deletion docs/user/BuildWithWSL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Windows Subsystem for Linux, or WSL for short is a way for you to mount a Linux-based OS onto your Windows machine, allowing you to build OpenROAD-flow-scripts both locally and via Docker.

## Install WSL
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: Ubuntu 22.04, RHEL 8, RockyLinux 9, Debian 11.
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: Ubuntu 22.04, RHEL 8, RockyLinux 9.

@gemini-code-assist gemini-code-assist Bot Oct 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

In WSL, users install Linux distributions (or distros) rather than kernels (WSL itself runs on a single Microsoft-provided Linux kernel). Also, "Rocky Linux" should be spelled with a space for consistency.

Suggested change
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: Ubuntu 22.04, RHEL 8, RockyLinux 9.
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any distribution supported, such as: Ubuntu 22.04, RHEL 8, Rocky Linux 9.


We recommend that users follow the Docker build by continuing onto the guide below. However, if you wish to install locally, you may follow the build locally instructions [here](./BuildLocally.md).

Expand Down