Make readme visible on pypi

README.md

@@ -8,7 +8,7 @@ M3 is a measurement mitigation technique that solves for corrected measurement p
 
 ## Installation
 
-You can `pip` install M3 in serial mode using PyPi and a compiler via:
+You can `pip` install M3 in serial mode using PyPi via:
 
 ```bash
 pip install mthree

setup.py

@@ -10,9 +10,7 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-"""mthree
-
-Matrix-free measurement mitigation
+"""M3: Matrix-free measurement mitigation
 """
 
 import os
@@ -47,7 +45,9 @@
 }
 DOCLINES = __doc__.split('\n')
 DESCRIPTION = DOCLINES[0]
-LONG_DESCRIPTION = "\n".join(DOCLINES[2:])
+this_dir = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(this_dir, 'README.md'), encoding='utf-8') as readme:
+    LONG_DESCRIPTION = readme.read()
 
 CYTHON_EXTS = ['compute', 'converters', 'hamming', 'matrix', 'probability', 'matvec'] + \
               ['expval', 'column_testing', 'converters_testing']
@@ -195,6 +195,7 @@ def run(self):
     packages=PACKAGES,
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
+    long_description_content_type='text/markdown',
     url="",
     author="Paul Nation",
     author_email="[email protected]",