Skip to content

Commit 1a2d00f

Browse files
authored
docs: point pre-built binary docs to OpenROAD VaultLink (#4707)
The Precision Innovations GitHub releases page is frozen and now sends readers to VaultLink. The pre-built packages there are for Ubuntu 22.04 and 24.04 only, and the file names have a new format. Also remove Debian 11 and Ubuntu aarch64 from the supported platform lists. The dependency installer does not support Debian 11. Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>
1 parent bf3f9b3 commit 1a2d00f

4 files changed

Lines changed: 12 additions & 16 deletions

File tree

‎docs/user/BuildLocally.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

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

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

99
``` shell
1010
git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts

‎docs/user/BuildWithDocker.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ docker run --rm ubuntu:22.04 nproc
3131
### Build Using Docker from pre-built binaries
3232

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

3838
We recommend to use a Docker image of a supported OS

‎docs/user/BuildWithPrebuilt.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,27 @@ Instructions for installing:
77
- [Klayout>=0.28.8](https://www.klayout.de/build.html)
88
- [Yosys>=0.58](https://github.com/YosysHQ/oss-cad-suite-build/blob/master/README.md#installation)
99

10-
```{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)).
11-
```
12-
1310
## Install OpenROAD
1411
Download pre-built binaries with self-contained dependencies
15-
included from the Precision Innovations' GitHub releases
16-
[here](https://github.com/Precision-Innovations/OpenROAD/releases).
12+
from [OpenROAD VaultLink](https://vaultlink.precisioninno.com/).
1713

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

20-
The following platforms are supported currently:
16+
Pre-built binaries are available for these platforms:
2117
- Ubuntu 22.04
22-
- Debian 11
18+
- Ubuntu 24.04
2319

2420
Use the following steps to download:
2521

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

28-
Step 2: Download the artifacts for your distribution.
24+
Step 2: Download the `.deb` package for your Ubuntu version.
2925

30-
Step 3: Run the install command based on platform use package installer.
31-
For example Ubuntu 22.04 use:
26+
Step 3: Install the package with `apt`.
27+
For example, on Ubuntu 22.04:
3228

3329
```shell
34-
sudo apt install ./openroad_2.0_amd64-ubuntu22.04.deb
30+
sudo apt install ./openroad_<version>_amd64-ubuntu-22.04.deb
3531
```
3632

3733
## Verify Installation

‎docs/user/BuildWithWSL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
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.
33

44
## Install WSL
5-
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.
5+
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.
66

77
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).
88

0 commit comments

Comments
 (0)