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

Link to examples in readme is broken #62

Open
dpetrisko opened this issue Dec 17, 2020 · 3 comments
Open

Link to examples in readme is broken #62

dpetrisko opened this issue Dec 17, 2020 · 3 comments

Comments

@dpetrisko
Copy link

https://github.com/bespoke-silicon-group/bsg_bladerunner/blob/master/bsg_replicant/README.md

@drichmond
Copy link
Collaborator

Thanks for pointing this out

Do you know how to link to a readme inside of a submodule? I don't want to hardlink to bsg_replicant because master is sometimes ahead of the latest version on bladerunner

@dpetrisko
Copy link
Author

https://github.com/bespoke-silicon-group/bsg_replicant/blob/9a87264c248d58e2eccb86a5ba6c406b9a4abc9d/README.md

Hm, that's tricky. Best I can see is using the commit tag in the url. It's possible you can do some fancy markdown magic to auto-update, but it'll lag if anyone forgets to update during a bump

@drichmond
Copy link
Collaborator

Yeah, that's what I don't want.

I think linking to master may be the best of a bunch of not great options. At least it's not out of date...

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

No branches or pull requests

2 participants