Skip to content

Commit 4713d3c

Browse files
luarssvvbandeira
andauthored
[Docs] clarity in docs (#1392)
* clarity in docs --------- Signed-off-by: luarss <[email protected]> Signed-off-by: Vitor Bandeira <[email protected]> Co-authored-by: Vitor Bandeira <[email protected]>
1 parent a3368b4 commit 4713d3c

File tree

4 files changed

+64
-9
lines changed

4 files changed

+64
-9
lines changed

docs/index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,33 @@ See these [tips](user/FAQS.md#how-do-i-get-better-search-results) to help improv
4545

4646
### Setup
4747

48+
#### Supported Operating Systems
49+
50+
Note that depending on the installation method, we have varying levels of
51+
support for various operating systems.
52+
53+
Legend:
54+
- `Y` for supported.
55+
- `-` for unsupported.
56+
57+
| Operating System | Local Installation | Prebuilt Binaries | Docker Installation | Windows Subsystem for Linux |
58+
| --- | --- | --- | --- | --- |
59+
| Ubuntu 20.04 | `Y` | `Y` | `Y` | `-` |
60+
| Ubuntu 22.04 | `Y` | `Y` | `Y` | `-` |
61+
| CentOS 7 | `Y` | `-` | `Y` | `-` |
62+
| CentOS 8 | `Y` | `-` | `Y` | `-` |
63+
| Debian 10 | `Y` | `Y` | `Y` | `-` |
64+
| Debian 11 | `Y` | `Y` | `Y` | `-` |
65+
| RHEL | `Y` | `-` | `Y` | `-` |
66+
| Windows 10 and above | `-` | `-` | `Y` | `Y` |
67+
| macOS | `Y*` | `-` | `Y` | `-` |
68+
69+
```{warning}
70+
For macOS, local compilation for the modules `par` and `mpl2` are not
71+
fully supported due to an upstream issue with `or-tools`. We recommend
72+
Docker installation wherever possible.
73+
```
74+
4875
#### System Requirements
4976

5077
To build the binaries and run `gcd` through the flow:

docs/toc.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ entries:
55
title: User Guide
66
entries:
77
- file: user/BuildWithDocker
8-
title: Build With Docker
8+
title: Build Using Docker
99
entries:
1010
- file: user/DockerShell.md
1111
title: Docker Shell utility
1212
- file: user/BuildWithPrebuilt.md
13-
title: Build With Pre-built Binaries
13+
title: Build Using Pre-built Binaries
1414
- file: user/BuildLocally.md
1515
title: Build Locally
1616
- file: user/BuildWithWSL.md
17-
title: Build With WSL
17+
title: Build Using WSL
1818
- file: user/FlowVariables.md
1919
title: Flow Variables
2020
- file: contrib/Metrics.md

docs/user/BuildWithDocker.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,48 @@ then is recommended that you restrict the number of CPUs used by the scripts
1919
docker run --rm ubuntu:22.04 nproc
2020
```
2121

22-
You can restrict the number of CPUs with the `-t|--threads N` argument:
22+
### Build Using Docker from pre-built binaries
2323

24-
``` shell
25-
./build_openroad.sh --threads N
24+
Courtesy of [Precision Innovations](https://precisioninno.com/),
25+
they release `.deb` installers of OpenROAD for Ubuntu
26+
and Debian on a regular basis.
27+
This greatly helps to reduce the compilation time needed.
28+
29+
We recommend to use a Docker image of a supported OS
30+
and install OpenROAD using the prebuilt binaries from
31+
Precision Innovations.
32+
You can start the container in an interactive mode using
33+
the command below.
34+
35+
```shell
36+
docker run -it ubuntu:22.04
2637
```
2738

28-
## Clone and Build
39+
Now you are ready to install the prebuilt binaries.
40+
Please refer to the instructions for installing prebuilt binaries
41+
[here](./BuildWithPrebuilt.md).
42+
43+
### Build Using Docker from sources
44+
45+
Alternatively, if you would like the latest commits from the OpenROAD repositories,
46+
do follow the instructions below.
47+
48+
49+
#### Clone and Build
2950

3051
The following instructions build the docker image with CentOS 7 as the base OS:
3152

53+
3254
``` shell
3355
git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts
3456
cd OpenROAD-flow-scripts
35-
./build_openroad.sh
57+
./build_openroad.sh
58+
```
59+
60+
You can restrict the number of CPUs with the `-t|--threads N` argument:
61+
62+
``` shell
63+
./build_openroad.sh --threads N
3664
```
3765

3866
## Verify Installation

docs/user/UserGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The OpenROAD Project uses three tools to perform automated RTL-to-GDS layout gen
44

55
1. [yosys](https://github.com/The-OpenROAD-Project/yosys): Logic
66
Synthesis
7-
2. [OpenROAD App](https://github.com/The-OpenROAD-Project/OpenROAD):
7+
2. [OpenROAD](https://github.com/The-OpenROAD-Project/OpenROAD):
88
Floorplanning through Detailed Routing
99
3. [KLayout](https://www.klayout.de/): GDS merge, DRC and LVS (public
1010
PDKs)

0 commit comments

Comments
 (0)