RosettaCommons / rosetta

The Rosetta Bio-macromolecule modeling package.
https://www.rosettacommons.org
Other
154 stars 63 forks source link

Readme clarifications #34

Closed agitter closed 6 months ago

agitter commented 7 months ago

The public GitHub repo is great. I'm looking through the contents to understand everything that is here.

The readme references these subdirectories, but a few seem different in the actual directory tree:

The second paragraph of the readme also has a typo https://ww.rosettacommons.org/ (missing w)

smoe commented 7 months ago

I came up with https://github.com/RosettaCommons/rosetta/pull/27 - does that help?

smoe commented 7 months ago

@lyskov or @roccomoretti , is this something for either of you to comment on?

agitter commented 7 months ago

Thanks for the help @smoe. I haven't cloned locally and have only been browsing the source tree on GitHub so far.

I'm used to submodules being indicated on GitHub with the submodule name and the current commit, like those highlighted here image

I didn't realize that rosetta/source/bin/ and rosetta/source/build/ are also submodules. Is that what you are saying? Those are the two subdirectories I coudn't find while browsing in GitHub.

roccomoretti commented 7 months ago

rosetta/source/bin/ and rosetta/source/build/ are not submodules, but rather they're directories which will get autogenerated when you build Rosetta for the first time.

The two typos you point out (test and ww) are indeed typos.

agitter commented 7 months ago

Thanks @roccomoretti, that clears up my confusion. I mistakenly thought those directories were already committed in the repo, not created during the build.

Please feel free to either close this now or leave it as a reminder about the typos.

roccomoretti commented 6 months ago

I think all the points mentioned are now covered in PR #27 -- feel free to re-open this issue (or make a new one) if that's not the case.

agitter commented 6 months ago

Yes, that PR covered everything. Thanks!