GeneratorsLesson 57Free preview

README Generator

This lesson is part of Web Developer Tools · All levels

Summary

The README generator helps compile the initial documentation of the repository with the standard parts. A good README describes the project functionality, how to install, how to run, use examples, and licensing. This tool speeds up the creation of the framework so that new contributors can understand the project more easily.

Key points

README is the first repository front page that anyone else reads.
Include a brief description of installation, use, and licensing
Use a block of code with three backticks to make the commands easy to copy.
Add screenshots or demos to help with understanding
Keep the README accurate when the command or dependence changes

Full lesson

Code examples and quizzes

Full lessons, code examples, and quizzes are available to subscribers. 5 questions.