[Distutils] README.rst vs DESCRIPTION.rst

[Thomas Güttler]

one week has passed. I check the feedback. Most people want one README.rst.

I see the file was already updated: https://github.com/pypa/sampleproject/commit/e7de7861963274595c5b3b0d6942e35ce5a733bc

Issue solved.

Thank you Carl Meyer!

Regards,
  Thomas Güttler

Am 27.09.2015 um 12:20 schrieb Thomas Güttler:
> Zen of Python:
> 
>    There should be one-- and preferably only one --obvious way to do it.
> 
> I would like to find a default for the description file of a python package.
> 
> The sampleproject uses DESCRIPTION.rst
> https://github.com/pypa/sampleproject/blob/master/setup.py
> 
> But I guess it is more common to use README.rst.
> For example django uses this file name.
> 
> Any good reason to **not** use README.rst but a different
> name like DESCRIPTION.rst?
> 
> Of course anyone can use the name he wants. I just want an agreement
> for the name to make life easier for newcomers.
> 
> I will check this mail thread in a week or two and write
> a pull request to https://github.com/pypa/sampleproject/blob/master/setup.py
> if there is an agreement.
> 
> If an agreement was found, which other documents should be updated?
> 
> Regards,
>    Thomas Güttler
> 
> 
> 
> 
> 


-- 
http://www.thomas-guettler.de/