Skip to content

Commit 752d970

Browse files
committed
Add README as long description
1 parent 6ab0e3d commit 752d970

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

setup.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
# -*- coding: utf-8 -*-
44
import os
5+
from pathlib import Path
56
import sys
67
import subprocess
78

@@ -100,6 +101,7 @@ def build_extension(self, ext):
100101
["cmake", "--build", "."] + build_args, cwd=self.build_temp
101102
)
102103

104+
long_description = (Path(__file__).parent / "README.md").read_text()
103105

104106
# The information here can also be placed in setup.cfg - better separation of
105107
# logic and declaration, and simpler if you include description/version in a file.
@@ -111,6 +113,8 @@ def build_extension(self, ext):
111113
author_email="m.worchel@campus.tu-berlin.de",
112114
license='MIT',
113115
url='https://github.com/mworchel/xatlas-python',
116+
long_description=long_description,
117+
long_description_content_type='text/markdown',
114118
ext_modules=[CMakeExtension("xatlas")],
115119
cmdclass={"build_ext": CMakeBuild},
116120
zip_safe=False,

0 commit comments

Comments
 (0)