Python打包工具期望我们的自述文件应命名为README或README.txt。但是，如果遵循此约定，GitHub会在项目页面中将其显示为纯文本，这不是很漂亮。 (与命名为README.rst的漂亮HTML版本不同)
有什么技术可以使PyPI和GitHub对README感到满意。
最佳答案
您可以使用git filter driver，它会在 checkout 时获取README.md(GitHub所需)并生成正确的README(Python需要)，尽管Lennart Regebro的answer建议PyPI不需要任何README文件)
因此，撇开PyPI不需要README(并且可以简单地忽略警告)这一事实，您可以(通常)使用Git生成所需文件:
但是，对该私有(private)文件README的任何修改都需要手动报告给README.md文件(至少由于markdown语法，脚本无法为您猜测)
这就是为什么Noufal Ibrahim的answer(我赞成)可能会更适应的原因，特别是如果您可以访问符号链接(symbolic link)(我仍在使用Windows Xp，那么我就没有运气了):
使README是README.rst的符号链接(symbolic link)，或者作为Arto Bendiken注释:
=> ，其中README.rst是符号链接(symbolic link)ro README 。
Git将存储符号链接(symbolic link)(和not the file the symlink refers to)，因此您可以在Git存储库中同时拥有README及其README.rst文件。
关于python - 适用于Python项目的README扩展，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/4384796/