Файл README
Коротко: README — титульна сторінка проєкту: текстовий файл (зазвичай README.md), що пояснює, що це за проєкт, як його встановити й використовувати.
Докладніше: GitHub і GitLab автоматично показують README на сторінці проєкту. Це часто перше, що бачать користувачі й рекрутери, і воно позбавляє безлічі запитань.
Подробиці
- Вміст: назва та короткий опис, встановлення…
Див. також: GitLab, коментарі в коді