Файл README
Коротко: README — титульная страница проекта: текстовый файл (обычно README.md), объясняющий, что это за проект, как его установить и использовать.
Подробнее: GitHub и GitLab автоматически показывают README на странице проекта. Это часто первое, что видят пользователи и рекрутёры, и оно избавляет от множества вопросов.
Подробности
- Содержание: название и краткое описание, установка…
См. также: GitLab, комментарии в коде