Merge pull request #116 from hartwork/readme-rst-to-markdown

`README.rst`: Migrate from reStructuredText to Markdown

Author: hartwork

README.md

@@ -0,0 +1,48 @@
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![Run the test suite](https://github.com/hartwork/resolve-march-native/actions/workflows/run-tests.yml/badge.svg)](https://github.com/hartwork/resolve-march-native/actions/workflows/run-tests.yml)
+
+
+# About
+
+**resolve-march-native** is a small command line tool to resolve
+`-march=native` into explicit GCC flags.
+
+
+# Example
+
+```console
+$ resolve-march-native --vertical
+-march=bonnell
+-mno-cx16
+--param l1-cache-line-size=64
+--param l1-cache-size=24
+```
+
+
+# Usage
+
+```console
+$ COLUMNS=80 resolve-march-native --help
+usage: resolve-march-native [-h] [--debug] [--gcc COMMAND] [--vertical]
+                            [--keep-identical-mtune] [--keep-mno-flags]
+                            [--add-recommended] [--version]
+
+options:
+  -h, --help            show this help message and exit
+  --debug               enable debugging (default: disabled)
+  --gcc COMMAND         gcc command (default: gcc)
+  --vertical            produce vertical output (default: horizontal output)
+  --keep-identical-mtune
+                        keep implied -mtune=... despite architecture identical
+                        to -march=... (default: stripped away)
+  --keep-mno-flags      keep -mno-* parameters (default: (superfluous ones)
+                        stripped away)
+  --add-recommended, -a
+                        add recommended flags (default: not added)
+  --version             show program's version number and exit
+
+Software libre licensed under GPL v2 or later.
+Brought to you by Sebastian Pipping <[email protected]>.
+
+Please report bugs at https://github.com/hartwork/resolve-march-native/issues — thank you!
+```

README.rst

@@ -16,13 +16,17 @@ def _read(filename):
     setup(
         name='resolve-march-native',
         description='Tool to determine what GCC flags -march=native would resolve into',
-        long_description=_read('README.rst'),
+        long_description=_read('README.md'),
+        long_description_content_type='text/markdown',
         license='GPLv2+',
         version=VERSION_STR,
         author='Sebastian Pipping',
         author_email='[email protected]',
         url='https://github.com/hartwork/resolve-march-native',
         python_requires='>=3.8',
+        setup_requires=[
+            'setuptools>=38.6.0',  # for long_description_content_type
+        ],
         packages=[
                 'resolve_march_native',
         ],