documentation: transform README.rst to README.md

[tboenig]

Please transform your README file to markdown file format and check it for completeness. Thank you very much.

[bertsky]

I can do that (using pandoc). But really? Why not rST? You are going to need rST import anyway when capturing the rich docstrings of Python source code.

[kba]

Consistency. We're using Markdown for documentation everywhere and it makes generating documentation more robust if READMEs are all Markdown

You are going to need rST import

You mean for generating apidocs with sphinx? sphinx supports markdown by extension, so that wouldn't be a problem.

check it for completeness

@tboenig Can you elaborate, also for other MP, what that entails?

[bertsky]

Fixed by #82.

You are going to need rST import

You mean for generating apidocs with sphinx? sphinx supports markdown by extension, so that wouldn't be a problem.

Are you suggesting we should also convert our rST docstrings? (rST is recommended by PEP 287.)

[kba]

Fixed by #82.

🙇

Are you suggesting we should also convert our rST docstrings? (rST is recommended by PEP 287.)

No.