Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown readme #2733

Merged
merged 3 commits into from
Nov 12, 2022
Merged

Markdown readme #2733

merged 3 commits into from
Nov 12, 2022

Conversation

janosh
Copy link
Member

@janosh janosh commented Nov 10, 2022

Convert the readme from rST to markdown:

pandoc --from rst --to gfm README.rst --output README.md

Any objections @shyuep? markdown is more readable, much more widely used and understood than rST so should allow more people to contribute updates/corrections.

@janosh
Copy link
Member Author

janosh commented Nov 10, 2022

This change allows us to have a single source of truth for GH and PyPI pages since setup.py currently contains basically a diverged copy of the rST readme as markdown.

@coveralls
Copy link

coveralls commented Nov 10, 2022

Coverage Status

Coverage increased (+32.9%) to 32.908% when pulling 7eb3e16 on markdown-readme into 29b0552 on master.

@janosh janosh merged commit 607e48d into master Nov 12, 2022
@janosh janosh deleted the markdown-readme branch November 12, 2022 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants