Was braucht eine gute Readme?

Markdown

Detaillierte Doku für Open Source Projekte auf GitHub

Documentation is more important than most people are willing to admit. If you want your project to be used though, you have to invest in it. As a bonus, you might also be able to get some good unit tests for free too. In this series of video's we'll highlight how we've set up documentation for clumper.

interrogate

dearme

Wie schreibe ich eine gute Readme → see here!

deon

Spinx

Sphinx makes it easy to create intelligent and beautiful documentation.

Spinx