Rename README to README.md

arthurdejong · arthurdejong · commit 3406c247ed9d · 2021-10-03T14:47:41.000+02:00
Mostly to please GitHub. See arthurdejong#280
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
-include README NEWS ChangeLog COPYING *.py tox.ini
+include README.md NEWS ChangeLog COPYING *.py tox.ini
 recursive-include tests *.doctest *.dat *.py
 recursive-include docs *.rst *.py
 recursive-include online_check *
diff --git a/README.md b/README.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,6 @@
 .. module:: stdnum
 
-.. include:: ../README
+.. include:: ../README.md
    :end-before: Available formats
 
 
diff --git a/setup.py b/setup.py
@@ -36,14 +36,15 @@
 
 base_dir = os.path.dirname(__file__)
 
-with open(os.path.join(base_dir, 'README'), 'rb') as fp:
+with open(os.path.join(base_dir, 'README.md'), 'rb') as fp:
     long_description = fp.read().decode('utf-8')
 
 setup(
     name='python-stdnum',
     version=stdnum.__version__,
     description='Python module to handle standardized numbers and codes',
     long_description=long_description,
+    long_description_content_type='text/markdown',
     author='Arthur de Jong',
     author_email='arthur@arthurdejong.org',
     url='https://arthurdejong.org/python-stdnum/',
diff --git a/update/numlist.py b/update/numlist.py
@@ -20,7 +20,7 @@
 # 02110-1301 USA
 
 """This script uses introspection to present a list of number formats
-suitable to be included in the README and stdnum package description."""
+suitable to be included in the README.md and stdnum package description."""
 
 import os.path
 import sys
@@ -47,7 +47,7 @@ def get_number_modules():
 
 
 if __name__ == '__main__':
-    print('For README:')
+    print('For README.md:')
     print('')
     for module in get_number_modules():
         print(' * %s' % util.get_module_name(module))

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-include README NEWS ChangeLog COPYING *.py tox.ini`
	`1`	`+include README.md NEWS ChangeLog COPYING *.py tox.ini`
`2`	`2`	`recursive-include tests .doctest .dat *.py`
`3`	`3`	`recursive-include docs .rst .py`
`4`	`4`	`recursive-include online_check *`