Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

# Update bazel-orfs documentation #88

Merged

Conversation

ivysochyn
Copy link
Contributor

Update bazel-orfs documentation

This PR enhances the documentation in the README.md file and eliminates outdated files.

This PR modifies the following:

  • README.md - Updated to reflect the current state of bazel-orfs project
  • Removed obsolete scripts
  • BUILD - Adjusted to account for removed scripts

Internal tracker: #62630

Signed-off-by: Illia Vysochyn <[email protected]>
Internal tracker: #62630

Signed-off-by: Illia Vysochyn <[email protected]>
Internal tracker: #62630

Signed-off-by: Illia Vysochyn <[email protected]>
Setting this attribute to a valid registry and image within this registry will enable Docker to automatically pull the image if it's not available locally.
Users can also build the image from ORFS sources following [the guide](https://openroad-flow-scripts.readthedocs.io/en/latest/user/BuildWithDocker.html#build-using-docker-from-sources).
It implicitly depends on a Docker image with ORFS environment pre-installed being present.
The Docker image used in the flow is defined in the [module](./MODULE.bazel) file, the default can be overridden by specifying modified `image` and `sha256` attributes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there is a default image, there should not be one.

@oharboe oharboe merged commit e16b82f into The-OpenROAD-Project:main Jul 30, 2024
6 checks passed
@ivysochyn ivysochyn deleted the ivysochyn/update-documentation branch July 31, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants