Reformat README as markdown document #3
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
github will render markdown documents as HTML, which gives us prettier fonts, better headings and the ability to do syntax highlighting for code. This makes the README easier to read on github.
Reformat the README document to take advantage of Markdown formatting. This can be easily converted to different formats including HTML and man pages. Also syntax highlight all code with appropriate language markers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
github will render markdown documents as HTML, giving us better fonts, headings and syntax highlighting. All of these make it easier to read the README document online. We can also easily convert .md files to html or man pages using a markdown parser.
This patch converts the README file to README.md and adds in markdown formatting.