Convert README to Markdown #125
Merged
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
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
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.
reStructuredText is powerful, and good for big documentation, but it's complex.
Let's prefer simpler Markdown for standalone README files.
One difference: with reST we can use
.. contents::to insert a table of contents. Markdown can't do that, we would need to manually add a hardcoded table. I've not done this (but can). Instead, GitHub automatically generates a ToC; for example click the icon at https://github.com/python/bedevere:For the badges, I added little PyPI and Python icons for the first two:
https://github.com/hugovk/cherry-picker/tree/convert-readme-to-md
What do you think of them? Maybe the PyPI one is a little unclear?