GitHub Skills

Learn how to use GitHub with interactive courses designed for beginners and experts.

skills.github.com

How to write a good README for your GitHub project?

It is worth or even necessary to add a README file in every new project. Today we will focus on good practices of writing such a file - with a few examples, and a ready to use template. README (as the name suggests: "read me") is the first file one should read when starting a new project.

bulldogjob.com

Writing a good README - newbies manual

Open a README.md. file in a new project.

Make sure the file always includes the following elements:

• Titles and internal titles
• Introduction - the project's aim
• Technologies
• Launch

Consider also using additional elements such as:

• Table of contents
• Illustrations
• Scope of functionalities
• Examples of use
• Project status
• Sources
• Other information