There are two README files

Question

There are two README files

eblume opened this issue 7 years ago · 4 comments

You've currently got two README files in the project's root directory. Probably not intentional? Note also the interaction with MANIFEST.in, which currently ignores README.md - maybe that's intentional?

Answer 1 · 2018-05-19T00:04:46.000Z

Correction - README.md is included by the recursive-include in MANIFEST.in

Answer 2 · 2018-05-19T17:16:28.000Z

This is more because github expects one thing and PyPI expects another thing. Consolidating those into an RST is probably a good idea.

Answer 3 · 2018-05-26T20:05:01.000Z

I thought github would accept either a README.md or README.rst as long as there is just on of the two. Also doesn't PyPI now accept README.md?

I guess the question is "which do we prefer?"

Answer 4 · 2018-05-29T15:50:06.000Z

When I started this repo, github hadn't yet added the .rst support.... I'm fine killing the .md one and using just RST, since it's more python-ecosystem friendly.