Change readme file extensions to rst for nice rendering

[danielunderwood]

No description provided.

[jaberg]

Thanks for the PR! I think there's a tension between the rendering on github and the rendering on pypi. Would you mind looking up best practice on dealing with that with Python packages?

[danielunderwood]

I wasn't aware of the pypi issue. It looks like the best practice is using reStructuredText since both GitHub and pypi support rendering of rst. It looks like the readme files for this project follow the syntax of rst, so no change is needed beyond an extension change.

I'll go ahead and make that change with the PR if that seems like an acceptable solution.

[jaberg]

Awesome, thanks for the info and that change would be great.

On Sun, Apr 24, 2016 at 4:54 PM, Daniel Underwood notifications@github.com
wrote:

I wasn't aware of the pypi issue. It looks like the best practice is using
reStructuredText since both GitHub and pypi support rendering of rst. It
looks like the readme files for this project follow the syntax of rst, so
no change is needed beyond an extension change.

I'll go ahead and make that change with the PR if that seems like an
acceptable solution.

—
You are receiving this because you commented.
Reply to this email directly or view it on GitHub
#70 (comment)

[danielunderwood]

I have pushed commits to change the readme files to the rst extension and highlight code in blocks in the main readme.