Skip to content

Commit

Permalink
README: Add information about ORFS variable
Browse files Browse the repository at this point in the history
Signed-off-by: Eryk Szpotanski <[email protected]>
  • Loading branch information
eszpotanski committed Apr 23, 2024
1 parent c09d39e commit d5318fe
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This repository contains [Bazel](https://bazel.build/) rules for wrapping Physic
## Requirements

* [Bazelisk](https://bazel.build/install/bazelisk) or [Bazel](https://bazel.build/install) - if using `bazel`, please refer to `.bazelversion` file for the recommended version of the tool.
* [OpenROAD-flow-scripts](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts) - **Required only for running `Make` targets** - must reside under `~/OpenROAD-flow-scripts`. `bazel-orfs` intentionally does not treat OpenROAD-flow-scripts as a installable versioned tool, but prefers to rely on `~/OpenROAD-flow-scripts` such that it is easy to hack ORFS and OpenROAD.
* [OpenROAD-flow-scripts](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts) - **Required only for running `Make` targets** - to use it, `ORFS` environmental variable has to be set to OpenROAD-flow-scripts location. `bazel-orfs` intentionally does not treat OpenROAD-flow-scripts as a installable versioned tool, but prefers to rely on local installation such that it is easy to hack ORFS and OpenROAD.
* [Docker](https://docs.docker.com/get-docker/) - **Required only for running `Stage` targets**
* Docker image with ORFS installation - **Required only for running `Stage` targets** - can be obtained in two ways:

Expand Down Expand Up @@ -177,7 +177,7 @@ Users can also build the image from ORFS sources following [the guide](https://o
#### Local flow

The local flow (`_make` bazel targets) depends on the locally installed ORFS.
OpenROAD-flow-scripts installation is expected to be located specifically under `~/OpenROAD-flow-scripts`.
OpenROAD-flow-scripts installation is expected to be specified in `ORFS` environmental variable.
For the installation guide please refer to the [build instructions](https://openroad-flow-scripts.readthedocs.io/en/latest/user/BuildLocally.html).
The local flow relies on `_make` bazel targets which are used to generate shell scripts.
Those shell scripts, apart from facilitating quick tests of ORFS modifications, can be used to run ORFS stages straight from the bazel-orfs repository and to allow tweaking the "moving parts" of the flow, like e.g.:
Expand Down

0 comments on commit d5318fe

Please sign in to comment.