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 INSTALLING to show how to install different tags #30

Open
wheatman opened this issue Jan 9, 2024 · 3 comments
Open

update INSTALLING to show how to install different tags #30

wheatman opened this issue Jan 9, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@wheatman
Copy link

wheatman commented Jan 9, 2024

can the https://github.com/OpenCilk/infrastructure/blob/release/INSTALLING.md page be updated to show how to install different branches/ tags This is helpful when testing out new versions, and also when trying to install old versions to recreate some old experiments.

I am talking about the -t flag to tools/get

@behoppe
Copy link
Member

behoppe commented Jan 11, 2024

Hi @wheatman and @neboat, as we address the original reported issue, let's also consider that the INSTALLING.md page is essentially subsumed by https://www.opencilk.org/doc/users-guide/build-opencilk-from-source/, which seems to have just a few extra advanced bits at the end. Probably we want to merge these somehow into a unified approach to documentation. There is a related issue OpenCilk/www.opencilk.org#219, which nominally is about OpenCilk/opencilk-project/README.md, where I welcome comments on how to coordinate our documentation-posting and ensure that users find current materials and not outdated "forks."

Brian, as our #1 user :-) I am curious about where you might expect to find documentation.

@behoppe behoppe added the documentation Improvements or additions to documentation label Jan 11, 2024
@wheatman
Copy link
Author

One way I think might be good is to have the quick version just on https://github.com/OpenCilk/opencilk-project/blob/dev/16.x/README.md and then have a pointer to the long version https://www.opencilk.org/doc/users-guide/build-opencilk-from-source/ I do see now that the extra info I was looking for is in fact in the readme, though it is not on the website. I feel like the issue with having it too many places is that they get out of sync. I think I just got used to going to https://github.com/OpenCilk/infrastructure/blob/release/INSTALLING.md because it used to be the source of truth, but perhaps now it should be removed and https://github.com/OpenCilk/infrastructure/blob/release/README.md simplified to mostly just point at the website, leaving https://github.com/OpenCilk/opencilk-project/blob/dev/16.x/README.md and the website to be the source of truth, and everything else just pointing at those things.

Though all this goes with the caveat that I know my way around a bit, and somebody unfamiliar might have other expectations

@behoppe
Copy link
Member

behoppe commented Jan 12, 2024

Thanks @wheatman. That's great to know that the info you were looking for is already in the README.

I will happily edit the interrelated docs for ease of use and maintenance (and to help people find the -t flag that started this issue). I also like the approach where the README is simple (and hence very stable) with a prominent pointer to the longer version on www.opencilk.org documentation (which changes more often). I can also edit INSTALLING similarly.

@neboat what do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants