Convert README to markdown #726
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
Signed-off-by: Vladimir Diaz <[email protected]>
Signed-off-by: Vladimir Diaz <[email protected]>
Signed-off-by: Vladimir Diaz <[email protected]>
Signed-off-by: Vladimir Diaz <[email protected]>
Signed-off-by: Vladimir Diaz <[email protected]>
Signed-off-by: Vladimir Diaz <[email protected]>
Signed-off-by: Vladimir Diaz <[email protected]>
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.
Fixes issue #:
The issue tracker does not have an issue for this task.
Description of the changes being introduced by the pull request:
This pull request converts the README to Markdown (from ReStructuredText). The current README doesn't display correctly on PyPI (due to some syntax error in the doc).
The README is being converted to Markdown because Warehouse and Twine now support it, is easier to maintain, and is consistent with the other docs in the repo.
Unrelated: The
virtualenvdependency indev-requirements.txtis updated to 16.0.0.Please verify and check that the pull request fulfills the following
requirements:
Signed-off-by: Vladimir Diaz <[email protected]>