A brief description of the project.
A more detailed description of the project or background information on how it came about, what the motivation behind it was.
Installation instructions.
Requirements might get listed in a sub section of the Installation section.
Usage examples. Will likely include:
$ code
Things the user should be aware of or watch out for, e.g. parts of the project that do not work like one might expect, information on how to avoid errors or conflicts etc.
A list of TODOs for unfinished projects/WIPs or a 'wishlist' for extensions/improvements. Might refer back to previously listed caveats.
Information on how to contribute to the project.
Section for listing resources, giving credit, listing people who helped with the project & similar. Might also make sense as 2+ separate sections.
Version history for the project.
Information on licensing; best done additionally to a LICENSE file.
README.template by K Kollmann is licensed under a Creative Commons Attribution 4.0 International License.
Note: If you base an own README file on this template, you might want to remove the HTML code above and just use the following bit:
This README was created using README.template by K Kollmann, which is licensed under a Creative Commons Attribution 4.0 International License.