Talk Python To Me - Python Conversations For Passionate Developers

#395: Tools for README.md Creation and Maintenance

Informações:

Synopsis

If you maintain projects on places like GitHub, you know that having a classy readme is important and that maintaining a change log can be helpful for you and consumers of the project. It can also be a pain. That's why I'm excited to welcome back Ned Batchelder to the show. He has a lot of tools to help here as well as some opinions we're looking forward to hearing. We cover his tools and a bunch of others he and I found along the way. Links from the show Ned on Mastodon: @nedbat@hachyderm.io Ned's website: nedbatchelder.com Readme as a Service: readme.so hatch-fancy-pypi-readme: github.com Shields.io badges: shields.io All Contributors: allcontributors.org Keep a changelog: keepachangelog.com Scriv: Changelog management tool: github.com changelog_manager: github.com executablebooks' github activity: github.com dinghy: A GitHub activity digest tool: github.com cpython's blurb: github.com release drafter: github.com Towncrier: github.com mktestdocs testing code samples in readmes: github.com shed: github.co