CLN: move README.rst to markdown

[cpcloud]

Because GitHub's rst is ugly

[jreback]

sexy :)

[jorisvandenbossche]

FYI, one of the reasons GitHub's rst is ugly, is not the fault of GitHub, but because the rst in README.rst was not wel formatted ..

Lists should not be indented (something also in the whatsnew and release notes is done wrong), that's why they looked like 'quotes' in the rendering of the README.

[cpcloud]

hm i seem to remember shoddy support for rst even with correct, and very basic markup

[jorisvandenbossche]

If I look at the README.rst, I think the lists is the only issue, apart form not nice rendering of internal links as :func:~pandas.io.html.read_html`` (but you converted them to normal links in the markdown version).

But maybe it has improved over time.

[cpcloud]

maybe. do you not like the new version? i think it's simpler and more clear

[jtratner]

does this mess up how PyPI looks?

[cpcloud]

arg ... yes it will .... could convert markdown to rst and put that in long
description but that's annoying ... have to change back
https://wiki.python.org/moin/CheeseShopTutorial

Best,
Phillip Cloud

On Mon, Sep 23, 2013 at 6:31 PM, Jeff Tratner [email protected]:

does this mess up how PyPI looks?

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/4888#issuecomment-24960865
.

[jorisvandenbossche]

@cpcloud No, I don't really bother about md or rst in the readme. I just saw the issue because there was someone complaining about because of the broken build.
I think the only thing I find less clear in the md version are the headers if you look at the plain text.

And I don't think it is a problem for PyPI, it is already using the LONG_DESCRIPTION in setup.py (but also there, the indentation is wrong).