Skip to content

Commit e362295

Browse files
committed
docs: point to the release page
Signed-off-by: Vitor Bandeira <[email protected]>
1 parent 3887cb2 commit e362295

File tree

4 files changed

+24
-20
lines changed

4 files changed

+24
-20
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ inside the container image.
2727
If `Docker` is not installed already, install latest docker tool
2828
based on OS from [here](https://docs.docker.com/engine/install/).
2929

30-
To manage docker as non-root user and verify that you can run `docker`
31-
commands without `sudo` must complete steps from [here](https://docs.docker.com/engine/install/linux-postinstall/).
30+
To manage docker as non-root user and verify that you can run
31+
`docker` commands without `sudo` must complete steps from
32+
[here](https://docs.docker.com/engine/install/linux-postinstall/).
3233

3334
#### Build ORFS with Docker
3435

@@ -38,11 +39,15 @@ Document for detailed steps on docker based installation found
3839
## Using the Flow
3940

4041
- For details about the OpenROAD and the available features and
41-
individual flows commands, see the documentation [here](https://openroad.readthedocs.io/en/latest/).
42-
- For details about automated flow setup, see ORFS docs [here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html).
42+
individual flows commands, see the documentation
43+
[here](https://openroad.readthedocs.io/en/latest/).
44+
- For details about automated flow setup, see ORFS docs
45+
[here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html).
4346
- Flow tutorial to run the complete OpenROAD based flow from
44-
RTL-GDSII, see the tutorial [here](https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html).
45-
- To watch ORFS flow tutorial videos, check [here](https://theopenroadproject.org/video).
47+
RTL-GDSII, see the tutorial
48+
[here](https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html).
49+
- To watch ORFS flow tutorial videos, check
50+
[here](https://theopenroadproject.org/video).
4651

4752
## Citing this Work
4853

docs/images/debian_package.webp

-53 KB
Binary file not shown.

docs/images/select_artifacts.webp

-24.1 KB
Binary file not shown.

docs/user/BuildLocally.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ sudo ./setup.sh
1818
``` shell
1919
./build_openroad.sh --local
2020
```
21-
> **Note:** There is a `build_openroad.log` file that is generated with every build in the main directory. In case of filing issues, it can be uploaded in the "Relevant log output" section of OpenROAD-flow-scripts repo [issue form](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/issues/new?assignees=&labels=&template=bug_report_with_orfs.yml).
21+
> **Note:** There is a `build_openroad.log` file that is generated with every
22+
> build in the main directory. In case of filing issues, it can be uploaded
23+
> in the "Relevant log output" section of OpenROAD-flow-scripts repo
24+
> [issue form](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/issues/new?assignees=&labels=&template=bug_report_with_orfs.yml).
2225
2326
## Verify Installation
2427

@@ -55,25 +58,21 @@ The following platform are supported currently:
5558

5659
Use following steps to download:
5760

58-
Step 1: Click on the [link](https://github.com/Precision-Innovations/OpenROAD/actions/workflows/github-actions-build-deb-package.yml)
61+
Step 1: Click on the [link](https://github.com/Precision-Innovations/OpenROAD/releases).
5962

60-
Step 2: Select the latest build with a green check `Build debian package`
63+
Step 2: Download the artifacts for your distribution.
6164

62-
![debian_package](../images/debian_package.webp)
63-
64-
Step 3: At the bottom of the page download the artifacts for your
65-
distribution.
66-
67-
![select_artifacts](../images/select_artifacts.webp)
68-
69-
Step 4: Extract the files and based on platform use package installer.
70-
For example Ubuntu platform use
71-
```
72-
sudo dpkg -i openroad_2.0_amd64-ubuntu20.04.deb
65+
Step 3: Run the install command based on platform use package installer.
66+
For example Ubuntu 20.04 use:
67+
```shell
68+
sudo apt install ./openroad_2.0_amd64-ubuntu20.04.deb
7369
```
7470

7571
You can install these binaries within docker as well.
7672

73+
> **Thanks** to Precision Innovations (www.precisioninno.com) for providing
74+
> and supporting this daily release of pre built installers to the community.
75+
7776
## Compiling and debugging in Visual Studio Code
7877

7978
Set up environment variables to point to tools that CMake from within

0 commit comments

Comments
 (0)