This page is not translated yet — showing the Russian text.
README
README.md в корне показывается под списком файлов и служит описанием репозитория; README в репозитории с именем как у тебя — визитка профиля.
In this article
Где показывается#
Файл README.md в корне репозитория (или в корне папки) показывается под таблицей файлов —
с разметкой, формулами и картинками. Это первое, что видит человек, открывший репозиторий.
Зачем#
- Объясни, что здесь лежит и как этим пользоваться.
- Дай оглавление — ссылки на главные файлы и папки.
- Для публичного репозитория README — ещё и то, что видит поисковик: репозиторий попадает в карту сайта, когда он публичный, в нём есть хотя бы один коммит и README с текстом (или задано описание).
Визитка профиля#
Заведи репозиторий с именем, равным твоему логину, и положи в него README.md: его текст
появится на странице твоего профиля. У организаций работает так же.
Was this helpful?