There are two README files

Question

There are two README files

eblume opened this issue 6 years ago · 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?

Erich Blume · Answer 1 · Sat May 19 2018 08:04:46 GMT+0800 (China Standard Time)

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

Philip James · Answer 2 · Sun May 20 2018 01:16:28 GMT+0800 (China Standard Time)

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

Tom · Answer 3 · Sun May 27 2018 04:05:01 GMT+0800 (China Standard Time)

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?"

Philip James · Answer 4 · Tue May 29 2018 23:50:06 GMT+0800 (China Standard Time)

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.