readme and long description

Author: andiwand

.github/workflows/pip.yaml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-22.04, windows-2022, macos-13]
+        os: [ubuntu-22.04, macos-13, windows-2022]
         python-version: ["3.7", "3.11"]
     runs-on: ${{ matrix.os }}
     steps:

README.md

@@ -0,0 +1,3 @@
+# It's Android's first OpenOffice Document Reader!
+
+This is a Python frontend for our C++ OpenDocument.core library. Feel free to use it in your own project too, but please don't forget to tell us about it!

setup.py

@@ -1,6 +1,7 @@
 from skbuild_conan import setup
 from setuptools import find_packages
 import subprocess
+from pathlib import Path
 
 
 conan_odr_remote = "https://artifactory.opendocument.app/artifactory/api/conan/conan"
@@ -18,6 +19,8 @@
         check=True,
     )
 
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
 
 setup(
     name="pyodr",
@@ -26,6 +29,7 @@
     author_email="[email protected]",
     description="It's Android's first OpenOffice Document Reader for Python!",
     long_description="",
+    long_description_content_type="text/markdown",
     python_requires=">=3.7",
     cmake_minimum_required_version="3.12",
     packages=find_packages("src"),