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

README: update instructions and usage guide #23

Merged
merged 1 commit into from
Apr 16, 2024

Conversation

lpawelcz
Copy link
Contributor

Here are some initial updates to the README. Some of the changes describe modifications that will come in follow-up PRs with regards to handling of docker images. Please let us know if there are some additional topics that you would want to have included in this README.
There will be also an update to the megaboom README (e.g. pointing to bazel-orfs README for initial setup and usage guide)

CC @oharboe

Copy link
Collaborator

@oharboe oharboe left a comment

Choose a reason for hiding this comment

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

nits

@lpawelcz
Copy link
Contributor Author

Good catches, thank you.
I also rephrased a little bit the paragraph about fetching docker image as this will be the next thing I will improve

@lpawelcz
Copy link
Contributor Author

Bumped after deciding to leave orfs_env bazel target in #25 (for reference: #22 (comment))

@oharboe oharboe merged commit c4fc0c5 into The-OpenROAD-Project:main Apr 16, 2024
8 checks passed
@lpawelcz lpawelcz deleted the readme-update branch April 16, 2024 13:10
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