Skip to content

Commit 37225e1

Browse files
committed
a better way to upload the README to pypi
1 parent 2f6f4de commit 37225e1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ dependencies = [
3131
]
3232
requires-python = '>=3.8'
3333
keywords = ['textile', 'text', 'html markup']
34-
# use pandoc to generate a markdown version of the README before uploading:
35-
# pandoc README.textile -o README.md
36-
# this kinda hurts to have to do this.
37-
readme = {file = 'README.md', content-type = 'text/markdown'}
34+
# Use the following command to generate a README.txt which is compatible with
35+
# pypi's readme rendering:
36+
# pytextile README.textile | sed -e 's/^\t//' > README.txt
37+
readme = {file = 'README.txt', content-type = 'text/markdown'}
3838

3939
[project.optional-dependencies]
4040
develop = ['pytest', 'pytest-cov']

0 commit comments

Comments
 (0)