Skip to content

Commit 7e4add6

Browse files
authored
Merge pull request #891 from bhrutledge/866-readme
Packaging Python Projects: Tweak README section
2 parents 8fb9ad4 + 66121cd commit 7e4add6

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -331,11 +331,10 @@ if you'd like.
331331
to write your content.
332332
333333
334-
Because our build script loads :file:`README.md` to provide a ``long_description``
335-
for :func:`setup`, the :file:`README.md` must be included along with your code
336-
when you `generate a source distribution <generating archives>`_.
337-
:ref:`setuptools` 36.4.0 or above will automatically include :file:`README.md`
338-
if it exists.
334+
Because our configuration loads :file:`README.md` to provide a
335+
``long_description``, :file:`README.md` must be included along with your
336+
code when you :ref:`generate a source distribution <generating archives>`.
337+
Recent versions of :ref:`setuptools` will do this automatically.
339338

340339

341340
Creating a LICENSE

0 commit comments

Comments
 (0)