WIP - Update and rename README.rst to README.md

[ryaminal]

Convert README from rst to markdown(markup?)

Rename and convert rst to markdown using pandoc

Motivation

Support syntax highlighting for the main README.

Currently without syntax highlighting the README is quite challenging to read from the browser

This is a Github issue, I believe.
Apparently Github just stopped syntax-highlighting on rst code-blocks?

Tests

This file is used in some tests and is doctested.

If this change is at all desirable, I will fix all those but figured I'd gauge the interest here before going too crazy.

Checklist

Before you create the PR, please make sure you have:

• Picked a concise, informative and complete title
• Clearly explained the motivation behind the PR
• Linked to any existing issues that your PR will be solving
• Included tests for any new functionality
• Checked that all unit tests pass

[ddelange]

there was a widespread highlighting outage not long ago, causing github to switch to treesitter for most languages. maybe it's a remnant. asked in the thread: github-linguist/linguist#6668 (comment)

[ddelange]

it's a new issue: github/markup#1796

[mpenkov]

setup.py (and thus PyPI) relies on the readme being in RST format.

smart_open/setup.py

Line 59 in b3d8621

long_description=read('README.rst'),

I'd rather not mess with it unless we absolutely have to.

[ddelange]

fwiw

setup.py can take long_description_content_type="text/markdown"
https://github.com/ddelange/pipgrip/blob/e191348bdcec4305b77e8220dd9b6735999cb91d/setup.py#L62

pyproject.toml will even read the readme contents for you, and detect content type based on extension
https://github.com/ddelange/mapply/blob/5ed4003bb2b5184724019df9ed0f132f6ee69dd3/pyproject.toml#L8

both render properly on pypi

[ryaminal]

Looks like github fixed the issue upstream. Feel free to close this.