From 89abb51da4d8624576306868ffe6c76c0890e9d3 Mon Sep 17 00:00:00 2001 From: Vitor Bandeira Date: Tue, 20 Oct 2026 18:23:55 -0300 Subject: [PATCH] docs: point pre-built binary docs to OpenROAD VaultLink 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 --- docs/user/BuildLocally.md | 2 +- docs/user/BuildWithDocker.md | 4 ++-- docs/user/BuildWithPrebuilt.md | 20 ++++++++------------ docs/user/BuildWithWSL.md | 2 +- 4 files changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/user/BuildLocally.md b/docs/user/BuildLocally.md index 338424ac27..c04d55d8eb 100644 --- a/docs/user/BuildLocally.md +++ b/docs/user/BuildLocally.md @@ -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. ``` shell git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts diff --git a/docs/user/BuildWithDocker.md b/docs/user/BuildWithDocker.md index efc2f8ea86..adbe6ae92e 100644 --- a/docs/user/BuildWithDocker.md +++ b/docs/user/BuildWithDocker.md @@ -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 diff --git a/docs/user/BuildWithPrebuilt.md b/docs/user/BuildWithPrebuilt.md index 8f1c95a6fa..254ee927ce 100644 --- a/docs/user/BuildWithPrebuilt.md +++ b/docs/user/BuildWithPrebuilt.md @@ -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__amd64-ubuntu-22.04.deb ``` ## Verify Installation diff --git a/docs/user/BuildWithWSL.md b/docs/user/BuildWithWSL.md index 94ab25dc68..752343bbe0 100644 --- a/docs/user/BuildWithWSL.md +++ b/docs/user/BuildWithWSL.md @@ -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. 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).