Update install instructions, and move from README to readthedocs #105
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nsmith-
reviewed
Oct 20, 2021
nsmith-
approved these changes
Oct 21, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think the README was getting a bit long, and the installation instructions missing a few updates (no need to install in recent CMSSW versions, install from source in case of ABI problems), so I restructured that part a bit, and moved it to its own page of the sphinx documentation (ideally the same should be done for a "creating corrections" page, but I'm not as familiar with that).
I also copied the upper part of the README to the introduction page there, but I'm not sure if it needs to stay in both.
To avoid reformatting (and because I think it lowers the threshold to contribute) I added myst-parser and used markdown for these two pages.
Please let me know if you agree, or if anything needs to be changed.