README literally means “read me”. The file sits in the main folder of the package on GitHub and describes installation, settings and examples. The chapters of the Extensions series give the most important steps and refer to the README and the docs folder for the rest.
Glossary Term
README
The description that belongs to a software package on GitHub: what it can do and how to install it.
- 6.1Events: dates, locations and recurrence Applies to: Extension “Events”
Chapters with this term
- 6.2Testimonials: maintaining ratings and quotes Applies to: Extension “Testimonials”