<ul>
<li>What’s a README?</li>
<li>Modern day added formatting. Mostly Markdown, sometimes Restructured Text.</li>
<li>What to include in a README?

<ul>
<li>Name the project</li>
<li>Intro / Summary / Overview</li>
<li>Prerequisites</li>
<li>Installation instructions</li>
<li>Usage instructions</li>
<li>Contribution instructions.</li>
<li>Credit for important contributors.</li>
<li>Acknowledgments of projects you based yours on.</li>
<li>Ways to communicate with you or the community.</li>
<li>License information.</li>
<li>Project status information in the form of badges.</li>
</ul></li>
</ul>

What’s a README? Modern day added formatting. Mostly Markdown, sometimes Restructured Text. What to include in a README? Name the project Intro / Summary / Overview Prerequisites Installation instructions Usage instructions Contribution instructions. Credit for important contributors. Acknowledgments of projects you based yours on. Ways to communicate with you or the community. License information. Project status information in the form of badges.

Episode 2 - Writing README files

Keep up with software engineering best practices and tradeoffs from tryexceptpass.org and around the web.

Share Episode 2 - Writing README files

Sign up to save your podcasts

Episode 2 - Writing README files

Episode 2 - Writing README files