Update README.md Readability #1
Open
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
The following information was difficult to follow and cluttered together with additional boxes. With the following change additional wording has been modified to provide clear context and repetition is reduced. Additionally added steps: to provide a clearer path what the user should take to outline them better, in case they are in a hurry and it makes it easier to follow. Changed directory example to its own codeblock, to make it stand out and clear.
VerzatileDev
commented
Jan 28, 2024
| <img align="right" alt="License" src="https://img.shields.io/badge/License%20:%20Unlicense-black?style=for-the-badge&logo=unlicense&logoColor=white&color=black&labelColor=black"> </a> | ||
|
|
||
| <br></br> | ||
| </br> |
There was a problem hiding this comment.
In Github Markdown, there isn't a need to provide additional <br> it can just be referenced as </br> Opens and closes, though with it it requires that there is 1 space above and below on where it has been added.
VerzatileDev
commented
Jan 28, 2024
|
|
||
| # Guide | ||
|
|
||
| ----------------------------------------------------------------------- |
There was a problem hiding this comment.
I think the guide's <h1> already splits it clearly enough so additional areas would clutter the information around it, instead I have used </br> to separate them from the previous
VerzatileDev
commented
Jan 28, 2024
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 following information was difficult to follow and cluttered together with additional boxes. With the following change additional wording has been modified to provide clear context and repetition is reduced.
Additionally added steps: to provide a clearer path what the user should take to outline them better, in case they are in a hurry and it makes it easier to follow.
Changed directory example to its own codeblock, to make it stand out and clear.
Fixes
#2