@@ -38,6 +38,31 @@ git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scri
3838cd OpenROAD-flow-scripts
3939./build_openroad.sh
4040```
41+ Options for ` ./build_openroad.sh ` script
42+ | Argument | Description |
43+ | -------------------------------| ---------------------------------------------------------------------------------------|
44+ | ` -h ` or ` --help ` | Print help message. |
45+ | ` -o ` or ` --local ` | Build locally instead of building a Docker image. |
46+ | ` -l ` or ` --latest ` | Use the head of branch --or_branch or 'master' by default for tools/OpenROAD. |
47+ | ` --or_branch BRANCH_NAME ` | Use the head of branch BRANCH for tools/OpenROAD. |
48+ | ` --or_repo REPO_URL ` | Use a fork at REPO-URL (https/ssh) for tools/OpenROAD. |
49+ | ` --no_init ` | Skip initializing submodules. |
50+ | ` -t N ` or ` --threads N ` | Use N cpus when compiling software. |
51+ | ` -n ` or ` --nice ` | Nice all jobs. Use all cpus unless ` --threads ` is also given, then use N threads. |
52+ | ` --yosys-args-overwrite ` | Do not use default flags set by this scrip during Yosys compilation. |
53+ | ` --yosys-args STRING ` | Aditional compilation flags for Yosys compilation. |
54+ | ` --openroad-args-overwrite ` | Do not use default flags set by this script during OpenROAD app compilation. |
55+ | ` --openroad-args STRING ` | Aditional compilation flags for OpenROAD app compilation. |
56+ | ` --lsoracle-enable ` | Compile LSOracle. Disable by default as it is not currently used on the flow. |
57+ | ` --lsoracle-args-overwrite ` | Do not use default flags set by this scrip during LSOracle compilation. |
58+ | ` --lsoracle-args STRING ` | Aditional compilation flags for LSOracle compilation. |
59+ | ` --install-path PATH ` | Path to install tools. Default is ` ${INSTALL_PATH} ` . |
60+ | ` --clean ` | Call git clean interactively before compile. Useful to remove old build files. |
61+ | ` --clean-force ` | Call git clean before compile. WARNING: this option will not ask for confirmation. Useful to remove old build files. |
62+ | ` -c ` or ` --copy-platforms ` | Copy platforms to inside docker image. |
63+ | ` --docker-args-overwrite ` | Do not use default flags set by this script for Docker builds. |
64+ | ` --docker-args STRING ` | Aditional compilation flags for Docker build. |
65+
4166
4267## Verify Installation
4368
0 commit comments