Improve formatting of the README #18
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
I found it very difficult to comprehend the README as it was written. I think better formatting is mostly all it needs. Here's what I did: * Switched it to Markdown, instead of just text * Put long lines all on one line, to allow Github to wrap them optimally * Replaced tabs with two spaces * Made headers, code examples, etc use Markdown format
|
+1 |
|
I agree. The formatting IMO would improve the README significantly. |
|
+1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
I found it very difficult to comprehend the README as it was written. I
think better formatting is mostly all it needs.
Here's what I did: