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 the usage instructions #40

Merged
merged 1 commit into from
Apr 22, 2024

Conversation

lpawelcz
Copy link
Contributor

@oharboe

This PR depends on The-OpenROAD-Project/bazel-orfs#27. Some of the instructions added here refer to GUI targets that are yet to be introduced to bazel-orfs. After merging The-OpenROAD-Project/bazel-orfs#27 we should pin new bazel-orfs version in MODULE.bazel and then merge this PR.

We also decided to remove Creating an issue report paragraph because we feel that it belongs to bazel-orfs documentation and will be added there alongside the support for make issue targets.
Perhaps most of the Tutorial chapter should eventually end up in bazel-orfs.
Please let us know what do you think.

@oharboe
Copy link
Collaborator

oharboe commented Apr 18, 2024

@lpawelcz all generic documentation on bazel-orfs should go into bazel-orfs. megaboom docs should contain little repetition of what is in bazel-orfs and mainly megaboom specific documentation.

@lpawelcz
Copy link
Contributor Author

@oharboe moved Tutorial paragraph to bazel-orfs README in The-OpenROAD-Project/bazel-orfs#29.
We've left a small part of this tutorial in megaboom README to warn the users to use correct label when downloading the docker image with orfs_env target.

@lpawelcz
Copy link
Contributor Author

CI failure is unrelated. To be fixed in #45.

@oharboe oharboe merged commit 5469c13 into The-OpenROAD-Project:main Apr 22, 2024
6 of 7 checks passed
@oharboe
Copy link
Collaborator

oharboe commented Apr 22, 2024

Let us just start with cleanup as a new baseline for documentation, even if there's more work to be done in bazel-orfs.

@lpawelcz lpawelcz deleted the readme-update branch April 23, 2024 06:22
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