Создание README.md
При публикации проект нужно описать. Так другие разработчики или потенциальные работодатели смогут понять, что представляет собой ваш проект. Такое описание принято указывать в файле README.md .
README.md — первое, что видит посетитель репозитория. Поэтому важно оформить этот файл так, чтобы его хотелось прочитать:
README.md — текстовый. Мы можем лишь дописывать в него символы или удалять их. Но в файле нет настроек шрифта, кегля, заголовков и отступов. Поэтому не получится разметить аккуратный файл в программе для вёрстки.
Но выход есть — язык разметки « маркдаун ». Как и HTML, маркдаун позволяет разметить документ на блоки: заголовки, абзацы, ссылки, списки. Но синтаксис у маркдауна другой. Разберёмся с ним.
Чтобы разметить файл README.md , нужно его сначала создать. Добавьте файл readme.md в корень вашего проекта.
Когда README.md оформлен, его остаётся запушить в удалённый репозиторий. После этого README.md начнёт встречать гостей вашего репозитория.
На гитхабе есть целый раздел, в котором можно подсмотреть примеры README.md в разных проектах: