Updated ReadMe in "updatedREADME" branch. #10107
Open
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
…ts, better organization, images, a list of key features, and some other information.
tyrasd
requested changes
Feb 16, 2024
There was a problem hiding this comment.
Hey, thanks for the suggestions. Looks not bad in general, but maybe you could address the following points:
- please replace the demo image with a lower resolution one: the image will be scaled to fit the width of the readme section on github. It does not really make sense to ship a 2560 pixel wide image whose details will be tiny, and the file size ends up unnecessarily large at 5MB
- the demo image should be put directly into the
imgfolder, not thedistone, right? currently, it does not load properly because of this - was it really necessary to change the listings from using
*to-? This unnecessarily increases the number of edited lines in this PR and makes it harder to follow the actual changes. I'd prefer if you could change this back to how it was in thedevelopmentbranch. 😊
Cheers!
|
Github added a native and automatic TOC feature a while back I recommend to close this PR and extract things that might still be useful to a separate PR. |
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 new README now includes a table of contents, better organization, images, a list of key features, a logo at the top, and some other information.