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

missing README file #33

Open
anthrotype opened this issue Nov 1, 2016 · 0 comments
Open

missing README file #33

anthrotype opened this issue Nov 1, 2016 · 0 comments

Comments

@anthrotype
Copy link
Member

Does anybody fancy adding a short README text file at the top-level of the repository?

I would like to use that for the long_description in setup.py, so that it can also be used for the project homepage on PyPI.

If it is formatted in reStructuredText instead of markdown it'd be even better, as currently PyPI cannot render .md files while Github can render .rst ones just fine.

It's easy to convert md to rst, e.g. with pandoc:
pandoc --from=markdown --to=rst --output=README.rst README.md

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

No branches or pull requests

1 participant