[SyneRBI/SIRF] README and installation (Issue #1361)
Edoardo Pasca
paskino created an issue (SyneRBI/SIRF#1361)The current README does not say how to install SIRF. This is terrible user experience.
I tend to follow a path I know to get to the docker container list. But this is very cumbersome and I know that the info is somewhere out there.
I suggest we have a section "Installing SIRF" with the VM and Docker clearly and shortly described.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Kris Thielemans
KrisThielemans left a comment (SyneRBI/SIRF#1361)I'm a bit ambivalent on this. The existing README points to the wiki, where relevant information is available. #1362 creates some extra links (with probably not enough information) and then points to the wiki anyway, so creating we have circular links.
I'd say that either we move everything from the wiki to the README and let the wiki point to this section in the SIRF/README, or we just keep it as-is.
Personally, given that a lot of the information on the wiki actually is maintained in the SIRF-SuperBuild or elsewhere, I think that moving it to the SIRF repo is not great. We could point to https://github.com/SyneRBI/SIRF-SuperBuild/blob/master/README.md, but it's a bit overwhelming at the moment. (The self-build option should probably be moved to SuperBuild/README). Of course, the SB isn't related to the CodeSpace (it currently only sits in SIRF-Exercises), so documenting that there doesn't make sense.
So, my feeling is that pointing to the wiki is currently best. It could be expanded of course (but should remain large a place with pointers to elsewhere with detailed info).
Of course, the disadvantage of the wiki is that it isn't (easily) versioned...
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Kris Thielemans
KrisThielemans left a comment (SyneRBI/SIRF#1361)I think we should have a section pointing to the SIRF-Exercises and SIRF-Contribs (not sure if we have that on the wiki).
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Edoardo Pasca
paskino left a comment (SyneRBI/SIRF#1361)I saw your comments. We can agree to disagree but I see the need of this change. This PR doesn't create new information, just points more clearly the user to the relevant information which we host elsewhere.
For instance, to find the docker information from the README it is currently 2 clicks if you get it right, but possibly is going back and forth a couple more.
Also it is not clear even if you make it to the right page for Docker: there are 4 links one has to choose: one to wikipedia about docker (do we need that?), one to a video and slides from David (probably outdated information looks like 2021), and finally the link one wants (not very prominent).
Call me lazy, but when I go to a GitHub repo I like to see how to install the software.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.