search

jaraco / irc

Full-featured Python IRC library for Python.
MIT License
392 stars 86 forks source link

Rename README.txt to README.md #73

Closed LizzyTrickster closed 8 years ago

LizzyTrickster commented 8 years ago

Makes the readme look a bit better :)

jaraco commented 8 years ago

Thanks for this. Unfortunately, I don't think markdown is yet supported on PyPI (at least not in the long_description). If I were to accept this pull, on the next release, the package page would not render properly.

I know there is some support for markdown in PyPI if no long description is provided, so removing the long_description may be a solution, except that in Python projects, I also tend to use restructured text for the CHANGES file and the documentation, often pulling the README or CHANGES into the documentation.

I think a better solution might be to rename the file to README.rst, which I believe Github will recognize as reStructuredText and render nicely, and also do the same with the CHANGES file.

jaraco commented 8 years ago

Again thanks, but I'm going to stick with reStructuredText for now. The README does render nicer after fbab7de6.

LizzyTrickster commented 8 years ago

I guessed there'd be something that didn't work. oh well :)

On 10 December 2015 at 13:53, Jason R. Coombs notifications@github.com wrote:

Closed #73 https://github.com/jaraco/irc/pull/73.

— Reply to this email directly or view it on GitHub https://github.com/jaraco/irc/pull/73#event-488190890.