convert README to .rst to make PyPI happy.

justvanrossum · May 1, 2020 · 5352554 · 5352554
1 parent 624be01
commit 5352554
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md → README.rst b/README.md → README.rst
@@ -1,4 +1,5 @@
-# fbdiff
+fbdiff
+~~~~~~
 
 `fbdiff` is a tool that reports a brief summary of table differences
 in OpenType fonts. It reports which tables exist in only one of the
@@ -9,6 +10,8 @@ It only looks at the binary data: tables are not parsed.
 
 Example usage:
 
+.. code:: sh
+
 	$ fbdiff fontA.ttf fontB.ttf
     Tables only in font B:
       meta
@@ -30,6 +33,8 @@ Example usage:
 
 Help text:
 
+.. code:: sh
+
 	$ fbdiff --help
 	usage: fbdiff [-h] [-o] FONT_A FONT_B
 

diff --git a/setup.py b/setup.py
@@ -1,7 +1,7 @@
 from setuptools import setup
 
 
-with open("README.md", "r", encoding="utf-8") as readme:
+with open("README.rst", "r", encoding="utf-8") as readme:
     long_description = readme.read()