From the course: Managing Python Projects
README.md
- [Instructor] You should have a ReadMe file at your repository. It should provide some documentation about your project, and some help for new developers on how to get by. It's very common to write ReadMe in Markdown format. GitHub and other services well render this Markdown to nice HTML, as you can see here. The first lines of the ReadMe should be an elevator pitch for your project. It should explain in short terms what your project is about. Usually after that comes uses, examples and more documentation. At the end we usually have some data for developers on how to get started hacking on the project. ReadMe is important, don't skip it and make sure it's updated.
Practice while you learn with exercise files
Download the files the instructor uses to teach the course. Follow along and learn by watching, listening and practicing.