Skip to content

Commit 1684f0b

Browse files
committed
README.md: Added instruction on using local Docker images
Signed-off-by: Grzegorz Latosinski <[email protected]>
1 parent 9a7ad1d commit 1684f0b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,13 +171,13 @@ orfs.default(
171171
use_repo(orfs, "docker_orfs")
172172
```
173173

174-
Setting this attribute to a valid image and checksum will enable Bazel to automatically pull the image and extract ORFS artifacts.
174+
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`:
175175

176176
```bash
177177
bazel build <target>_<stage>
178178
```
179179

180-
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.
180+
> **NOTE:** If `sha256` is set to an empty string `""`, Bazel will attempt to use a local image with name provided in the `image` field.
181181
182182
### Local flow
183183

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

190+
> **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.
191+
190192
A convenient way to re-run the floorplan and view the results would be:
191193

192194
```bash

0 commit comments

Comments
 (0)