tryexceptpass: Episode 2 - Writing README files

Summary

• 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.

from Planet Python
via read more