update README #313
Merged
update README #313
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
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #313 +/- ##
=======================================
Coverage 97.00% 97.00%
=======================================
Files 34 34
Lines 2667 2667
=======================================
Hits 2587 2587
Misses 80 80 ☔ View full report in Codecov by Sentry. |
K20shores
approved these changes
Oct 16, 2023
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.
The options figure in the README didn't end up looking that great in dark-mode to me, and some of the text was more related to the MUSICA library. I replaced the figure in the README with a short text description and links to the dependencies, but left the figure in the docs. See what you think.
Also, I moved the note about version 3.x.x being a refactor to the top of the README so it's more visible.