Code projects are required to have a README.md file in the root directory of the repository. The README.md file should provide an overview of the project, including its purpose, features, installation instructions, usage guidelines, and any other relevant information. A well-structured README.md file helps users understand the project and how to use it effectively.

The following applies to any and all courses which use version control for code submissions, including courses not primarily focused on programming.

[ companion video ]

• README files are constructed using Markdown syntax. Use this Markdown Guide to help you format your README files.
• Use this guide to help you learn How to Write a Good README File for Your GitHub Project.
• Use this guide to help you learn README Rules: Structure, Style, and Pro Tips
• Look at these in-class examples for ideas on how to structure your README files:
  • minicrawler
  • pytest-unit-testing
  • weather-snapshotter