Skip to content

Commit

Permalink
README.md: Added instruction on using local Docker images
Browse files Browse the repository at this point in the history
Signed-off-by: Grzegorz Latosinski <[email protected]>
  • Loading branch information
glatosinski committed Sep 10, 2024
1 parent 9a7ad1d commit 1684f0b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,13 @@ orfs.default(
use_repo(orfs, "docker_orfs")
```

Setting this attribute to a valid image and checksum will enable Bazel to automatically pull the image and extract ORFS artifacts.
Setting this attribute to a valid image and checksum will enable Bazel to automatically pull the image and extract ORFS artifacts on `bazel run` or `bazel build`:

```bash
bazel build <target>_<stage>
```

If the directory under the `<absolute_path>` does not exist, it will be created. If a relative path is provided, the `bazel run` command above will fail.
> **NOTE:** If `sha256` is set to an empty string `""`, Bazel will attempt to use a local image with name provided in the `image` field.
### Local flow

Expand All @@ -187,6 +187,8 @@ A locally built and modified [ORFS](https://openroad-flow-scripts.readthedocs.io
bazel run <target>_<stage>_deps -- <absolute_path> && <absolute_path>/make do-<stage>
```

> **NOTE:** If the directory under the `<absolute_path>` does not exist, it will be created. If a relative path is provided, the `bazel run` command above will fail.
A convenient way to re-run the floorplan and view the results would be:

```bash
Expand Down

0 comments on commit 1684f0b

Please sign in to comment.