33[ ![ 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/ )
44[ ![ Docs] ( https://readthedocs.org/projects/openroad-flow-scripts/badge/?version=latest )] ( https://openroad-flow-scripts.readthedocs.io/en/latest/?badge=latest )
55
6- OpenROAD-flow-scripts(ORFS) is a fully autonomous, RTL-GDSII flow
6+ OpenROAD-flow-scripts (ORFS) is a fully autonomous, RTL-GDSII flow
77for rapid architecture and design space exploration, early prediction
8- of QoR and detailed physical design implementation. However, ORFS
8+ of QoR and detailed physical design implementation. However, ORFS
99also enables manual intervention for finer user control of individual
10- flow stages through tcl commands and python APIs.
10+ flow stages through Tcl commands and Python APIs.
1111
1212![ ORFS_Flow.webp] ( ./docs/images/ORFS_Flow.webp )
1313
@@ -24,40 +24,25 @@ Docker image includes ORFS binaries, applications as well as all
2424required dependencies. All of the flow tools are encapsulated
2525inside the container image.
2626
27- If ` Docker ` is not installed already, refer to the document
28- [ here] ( ./docs/user/DockerInstall.md ) on how to install and how to
29- manage docker as non-root user.
27+ If ` Docker ` is not installed already, install latest docker tool
28+ based on OS from [ here] ( https://docs.docker.com/engine/install/ )
29+
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/ ) .
3032
3133#### Build ORFS with Docker
3234
3335Document for detailed steps on docker based installation found
3436[ here] ( ./docs/user/BuildWithDocker.md ) .
3537
36- ### Verify Local Installation
37- To verify installation run default ` gcd/nangate45 ` design with
38- following steps,
39-
40- ```
41- source env.sh
42- cd flow
43- make
44- ```
45-
46- Above steps run from RTL-GDSII generation and you can view final
47- layout with OpenROAD GUI as,
48-
49- ```
50- make gui_final
51- ```
52-
53- ![ gcd_final.webp] ( ./docs/images/gcd_final.webp )
54-
5538## Using the Flow
5639
57- - See the OpenROAD [ documentation here] ( https://openroad.readthedocs.io/en/latest/ ) .
58- - How to [ start using OpenROAD flow here] ( https://openroad-flow-scripts.readthedocs.io/en/latest/user/GettingStarted.html ) .
59- - See ORFS [ user guide here] ( https://openroad-flow-scripts.readthedocs.io/en/latest/user/UserGuide.html ) .
60- - See ORFS [ Flow Tutorial here] ( https://openroad-flow-scripts.readthedocs.io/en/latest/tutorials/FlowTutorial.html ) .
40+ - 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 ) .
43+ - 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 tuotial videos, check [ here] ( https://theopenroadproject.org/video ) .
6146
6247## Citing this Work
6348
0 commit comments