Reformat readme for markdown and reword it #528
Closed
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
|
Given the amount of time that has passed, and the fact that there are other competing PRs for the same issue, I will close this PR to avoid it going stale. Feel free to reopen if you decide to consider it. |
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 current readme doesn't look very nice on Github (see #475); this PR improves on it:
.mdextension (otherwise Github will render it as plain text)LICENSE, to.mdas well for completeness?I realize the last point in particular is subjective, so please let me know if my edits are too drastic. I felt that since Markdown formatting opens some possibilities for simplifying the text, I might as well clean it up a little. I can revert those changes and turn it into a pure reformat if the reviewers prefer.