The-OpenROAD-Project/OpenLane
1
0
Fork 0
mirror of https://github.com/The-OpenROAD-Project/OpenLane.git synced 2026-05-29 00:23:55 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add docker upgrade instructions to docs (#2132)

Browse Source 
Signed-off-by: Kareem Farid <kareefardi@users.noreply.github.com>
This commit is contained in:
Kareem Farid
2024-06-26 11:58:35 +03:00
committed by GitHub
parent 97f0c76032
commit a0e805e70f
4 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/getting_started/installation/installation_linux.md
View File

@@ -23,6 +23,10 @@ supported.
First, install Docker following the steps provided [in this link](https://docs.docker.com/engine/install/).
:::{note}
Make sure Docker is up to date with the latest release provided by your distribution.
:::
Test if installation was successful:
```

8
docs/source/getting_started/installation/installation_macos.md
View File

@@ -12,5 +12,13 @@ brew install python make
brew install --cask docker
```
If brew and the dependencies are already installed, make sure they are up to date:
```sh
brew update
brew upgrade python make
brew upgrade --cask docker
```
```{include} installation_common_section.md
```

5
docs/source/getting_started/installation/installation_ubuntu.md
View File

@@ -13,6 +13,11 @@ Only Ubuntu 20.04 and above are supported.
Next, install Docker.
Follow [the instructions provided in the Docker documentation here](https://docs.docker.com/engine/install/ubuntu/) as the steps provided below might be outdated.
:::{note}
If Docker is already installed, make sure that it is up to date by
[following these instructions in the Docker documentation](https://docs.docker.com/engine/install/ubuntu/#upgrade-docker-engine-1)
:::
:::{warning}
The steps below might become outdated, it is encouraged to follow the link to the official Docker documentation.
:::

5
docs/source/getting_started/installation/installation_win.md
View File

@@ -10,6 +10,11 @@ The following is the recommended installation method under Windows. Other virtua
1. Follow [official Microsoft documentation for WSL located here](https://docs.microsoft.com/en-us/windows/wsl/install) to install the WSL 2. Make sure your OS version supports WSL 2.
2. Follow [official steps to Install Docker Desktop on Windows located here](https://docs.docker.com/desktop/install/windows-install/).
:::{note}
Make sure to update Docker if it is already installed.
:::
3. Make sure that `WSL 2 Docker engine` is enabled and `Settings` -> `Resource` -> `WSL Integration` is enabled
4. Make sure that option `Start Docker Desktop when you login` is enabled in `Docker Desktop` -> `Settings`