README rewrite (v2) #146
Draft
README rewrite (v2) #146
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
|
oops, should be draft, not ready. |
JOJ0
approved these changes
Aug 28, 2024
There was a problem hiding this comment.
I carefully reviewed all the current changes in this draft via the rich-diff and I think this is ready to merge. I've added a tiny suggestion to complete a TODO. I think this is a good first iteration of a shorter and more concise README. We can always further shorten in future PR's. Good enough for now IMHO. What do you think? Merge?
Co-authored-by: J0J0 Todos <[email protected]>
Probably not |
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.
Reduce down the size of the README.md file so that users don't miss tiny things like the PyPI installation method, etc.
This has been sitting for a while, may be a bit messy right now. Don't merge until further notice or cleanup.
(Self reference for things to keep/yeet (check before marking as ready), also the big checklist)
(Previous version of README rewrite)