Merge pull request #1024 from vijayank88/readme_update

Readme update

Author: vvbandeira

README.md

@@ -3,16 +3,51 @@
 [![Build Status](https://jenkins.openroad.tools/buildStatus/icon?job=OpenROAD-flow-scripts-Public%2Fpublic_tests_all%2Fmaster)](https://jenkins.openroad.tools/view/Public/job/OpenROAD-flow-scripts-Public/job/public_tests_all/job/master/)
 [![Docs](https://readthedocs.org/projects/openroad-flow-scripts/badge/?version=latest)](https://openroad-flow-scripts.readthedocs.io/en/latest/?badge=latest)
 
-OpenROAD Flow is a full RTL-to-GDS flow built entirely on open-source tools.
-The project aims for automated, no-human-in-the-loop digital circuit design
-with 24-hour turnaround time.
+OpenROAD-flow-scripts (ORFS) is a fully autonomous, RTL-GDSII flow
+for rapid architecture and design space exploration, early prediction
+of QoR and detailed physical design implementation. However, ORFS
+also enables manual intervention for finer user control of individual
+flow stages through Tcl commands and Python APIs.
+
+![ORFS_Flow](./docs/images/ORFS_Flow.svg)
+
+## Tool Installation
+
+### Local Installation
+
+Document for detailed local installation steps found [here](./docs/user/BuildLocally.md).
+
+### Docker Based Installation
+
+To ease dependency installation issues, ORFS uses docker images.
+Docker image includes ORFS binaries, applications as well as all
+required dependencies. All of the flow tools are encapsulated
+inside the container image.
+
+If `Docker` is not installed already, install latest docker tool
+based on OS from [here](https://docs.docker.com/engine/install/).
+
+To manage docker as non-root user and verify that you can run
+`docker` commands without `sudo` must complete steps from
+[here](https://docs.docker.com/engine/install/linux-postinstall/).
+
+#### Build ORFS with Docker
+
+Document for detailed steps on docker based installation found
+[here](./docs/user/BuildWithDocker.md).
 
 ## Using the Flow
 
-- See the OpenROAD [documentation here](https://openroad.readthedocs.io/en/latest/).
-- How to [start using OpenROAD flow here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html).
-- Our [user guide here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/UserGuide.html).
-- Our [Flow Tutorial here](https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html).
+- For details about the OpenROAD and the available features and
+  individual flows commands, see the documentation
+  [here](https://openroad.readthedocs.io/en/latest/).
+- For details about automated flow setup, see ORFS docs
+  [here](https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html).
+- Flow tutorial to run the complete OpenROAD based flow from
+  RTL-GDSII, see the tutorial
+  [here](https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html).
+- To watch ORFS flow tutorial videos, check
+  [here](https://theopenroadproject.org/video).
 
 ## Citing this Work
 

docs/images/ORFS_Flow.svg

@@ -18,20 +18,61 @@ sudo ./setup.sh
 ``` shell
 ./build_openroad.sh --local
 ```
-> **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).
+> **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).
 
 ## Verify Installation
 
-The binaries should be available on your `$PATH` after setting up the
-environment.
+The binaries should be available on your `$PATH` after setting
+up the environment.
 
 ``` shell
 source ./env.sh
 yosys -help
 openroad -help
-exit
+cd flow
+make
 ```
 
+Above `make` command run from RTL-GDSII generation for default
+design `gcd` with `nangate45` pdk. You can view final layout with
+OpenROAD GUI as,
+
+```
+make gui_final
+```
+
+![gcd_final.webp](../images/gcd_final.webp)
+
+## Using Pre-built Binaries
+
+You can download pre-built binaries with self contained dependencies
+included from the Precision Innovations github repository
+[here](https://github.com/Precision-Innovations/OpenROAD/actions/workflows/github-actions-build-deb-package.yml).
+
+The following platform are supported currently:
+- Ubuntu 20.04/22.04
+- Debian 10/11
+
+Use following steps to download:
+
+Step 1: Click on the [link](https://github.com/Precision-Innovations/OpenROAD/releases).
+
+Step 2: Download the artifacts for your distribution.
+
+Step 3: Run the install command based on platform use package installer.
+        For example Ubuntu 20.04 use:
+```shell
+sudo apt install ./openroad_2.0_amd64-ubuntu20.04.deb
+```
+
+You can install these binaries within docker as well.
+
+> **Thanks** to Precision Innovations (www.precisioninno.com) for providing
+> and supporting this daily release of pre built installers to the community.
+
 ## Compiling and debugging in Visual Studio Code
 
 Set up environment variables to point to tools that CMake from within