Python包在GitHub上README应采用什么格式?
在Python的distutils
中,setup.py
会在包的根目录下寻找README
和README.txt
文件。而GitHub则支持像README.md
和README.rst
这样的格式。那么,我该如何写一个格式化的根目录README文件,既能满足这两者的要求呢?
我在这里看到的唯一建议是使用Pandoc来转换这些格式。不过,我希望尽量避免增加额外的构建步骤。
有没有什么方法可以告诉distutils
“使用我的README.rst”呢?
另外,当我运行python setup.py sdist
时,忽略这个警告会有什么不好的后果吗?
warning: sdist: standard file not found: should have one of README, README.txt
顺便说一下,我使用distutils.core
是因为谷歌把我引导到了这里。这个信息还算新吗?
1 个回答
1
看起来答案是用 setuptools
来代替 distutils.core
。如果你按照 setuptools 的说明 去做,你就能看到如何把你的默认 README 文件设置成 .rst 格式。