search

joshuaskelly / twitch-observer

Turn Twitch chatter into Python events
MIT License
26 stars 6 forks source link

Use long_description from README.md #73

Closed senpos closed 1 year ago

senpos commented 6 years ago

Closes #72

This change will make it easier to maintain README for both PyPI and repo, because actual text will come from a single place.

This idea comes from the official packaging tutorial.

Probably, nothing else should be done to make this work.

joshuaskelly commented 6 years ago

I noticed that the long description in setup.py doesn't include the Contributors section, but the README does. Will this render correctly on PyPi?

senpos commented 6 years ago

@joshuaskelly I believe so.

Check out this article, which claims that PyPI now supports GitHub-flavored Markdown since April 2018. Also, here is a discussion about it.

PythooonUser commented 6 years ago

I wish Sphinx would support GFM, too...

senpos commented 6 years ago

@PythooonUser Have you ever seen GitBook? :) They promise so many cool things ✨

PythooonUser commented 6 years ago

Oh, that looks nice!