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.

Sign up for GitHub

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

Jump to bottom

ORFS Git Guide should mention forking OR #2213

Open
vvbandeira opened this issue Aug 2, 2024 · 2 comments
Open

ORFS Git Guide should mention forking OR #2213

vvbandeira opened this issue Aug 2, 2024 · 2 comments
Assignees
@Krupakar-Reddy-S
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@vvbandeira
Copy link
Member

Subject

[Documentation] for documentation errors.

Describe the bug

Our current submodule setup also requires the user to fork the OpenROAD repo for their fork of ORFS to be able to build.
We need to include this in the docs here and likely mention it in the main readme as well.

Expected Behavior

The command git clone --recursive <FORK_URL> should work on forks.

Environment

Does not apply.

To Reproduce

Fork ORFS.
Do not fork OR.
Clone ORFS and try to build.

Relevant log output

No response

Screenshots

No response

Additional Context

No response
@vvbandeira vvbandeira added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 2, 2024
@Krupakar-Reddy-S
Copy link

i want to work on this

@maliberty
Copy link
Member

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Krupakar-Reddy-S Krupakar-Reddy-S

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@maliberty @vvbandeira @Krupakar-Reddy-S