The README document is the first point of entry into a code project, and the fundamental source of documentation. When viewing a project on GitHub, the README appears on the entry page immediately beneath the list of files and directories in the project. You will learn in the coming months that working with code with poor documentation can be a pain, so strive to provide good documentation for your work!
General project information (what does it do, who wrote it, who collaborated, which tools are used) Instructions for installation and use Information on the license Acknowledgements, etc.