From 1684f0bc0192dc45dc92d27ecb10f234e37b3201 Mon Sep 17 00:00:00 2001 From: Grzegorz Latosinski Date: Tue, 10 Sep 2024 21:23:18 +0200 Subject: [PATCH] README.md: Added instruction on using local Docker images Signed-off-by: Grzegorz Latosinski --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a19f1bd..38a4a77 100644 --- a/README.md +++ b/README.md @@ -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 _ ``` -If the directory under the `` 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 @@ -187,6 +187,8 @@ A locally built and modified [ORFS](https://openroad-flow-scripts.readthedocs.io bazel run __deps -- && /make do- ``` +> **NOTE:** If the directory under the `` 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