De-duplicate README content and update installation instructions #274
Conversation
This file contains hidden or 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #274 +/- ##
=======================================
Coverage 96.28% 96.28%
=======================================
Files 32 32
Lines 3606 3606
=======================================
Hits 3472 3472
Misses 134 134 ☔ View full report in Codecov by Sentry. |
jasonmcewen
approved these changes
Feb 25, 2025
Contributor
jasonmcewen
left a comment
jasonmcewen
left a comment
There was a problem hiding this comment.
LGTM! Please merge at your convenience.
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.
Resolves #264
Resolves #222
README.mdto make it more portable (uses absolute rather than relative links, avoids GitHub Flavour Markdown emoji references in favour of Unicode characters, adjusts some formatting and styling) to allow content to be reused..pip_readme.rstin favour of just using mainREADME.mdand updatesdocs/index.rstto includeREADME.mdcontent.README.mdupdates to reflect current approach for installing (optional) dependencies, and old installation instructions indocs/user_guide/install.rstremoved.