Convert README to reStructuredText so it looks good on PyPI

[vitorbaptista]

No description provided.

[vitorbaptista]

http://pandoc.org/try/ converted the README with no issues 👍

[pwalsh]

hmm. not too excited about this. I much prefer we standardise on markdown for contributors on github, rather than rst for a handful of readers on pypi.

[brew]

+1 @pwalsh

[pwalsh]

@vitorbaptista please revert.

[vitorbaptista]

GitHub supports both Markdown and rst, so it doesn't make much difference. The difference is only when writing the README, which should be quite rare and painless.

Actually, I think reStructuredText is more common in Python packages than Markdown (probably because of pypi). See some examples:

https://github.com/django/django/blob/master/README.rst
https://github.com/Pylons/pylons/blob/master/README.rst
https://github.com/pypa/pip/blob/develop/README.rst
https://github.com/kennethreitz/requests/blob/master/README.rst
https://github.com/zzzeek/sqlalchemy/blob/master/README.rst
https://github.com/ckan/ckan/blob/master/README.rst

I'm OK with reverting, though. It's not a big issue.

[brew]

Just my experience: I hate updating docs written in RST, so I'm less likely to update them. I consider Pypi's lack of support for md a bug.

[pwalsh]

I've also done my share of readme's in RST but can never remember the syntax.

[vitorbaptista]

It would be great if PyPI supported markdown, but I don't think it will anytime soon. I'm also more used to markdown, but using rst doesn't bother me.

In the end, shall I keep it or revert? I'm OK with both.

[femtotrader]

You may consider https://github.com/msabramo/setuptools-markdown

but some people hate it femtotrader/pandas_talib#8

[vitorbaptista]

Wow, good job on handling that guy's aggressiveness, @femtotrader 👏

Anyway, I wouldn't like to add a dependency just to write markdown instead of rst. Too much hassle for a few lines of text. I'm OK with either keeping it as it is or reverting this issue. I just don't want to spend too much time bikeshedding here.

[roll]

Conversion with pandoc can be part of Travis build before upload to PyPi I suppose. It will be just a dev dependency.

[pwalsh]

Request to revert still stands: OKI uses markdown for readme ;).

[vitorbaptista]

Done 👍