Ваш файл readme GitHub — это одна из первых вещей, которую кто-то увидит, когда проверит ваш профиль GitHub (конечно, если он у вас включен). Он не ограничивается только скучными текстами. Он может содержать эмодзи, статические изображения, анимированные изображения (GIF), списки, таблицы и встроенное содержимое.

Наше воображение — единственный предел того, что мы можем надеяться получить в будущем. — Чарльз Кеттеринг

Многие сделали несколько шагов вперед и создали полноценные игры от Крестики-нолики до Шахматы, в которые вы можете играть в их файле readme на GitHub. Однако это выходит за рамки данной статьи. Вот тщательно отобранный список некоторых замечательных профилей GitHub.

Почему ваш файл readme на GitHub важен?

Ваш файл readme на GitHub может выступать в качестве резюме, показывающего все ваши навыки посетителям вашего профиля, которые могут оказаться рекрутерами. Это также может помочь вам связаться с новыми разработчиками со схожими навыками.

Создание README.md для вашего профиля GitHub

Чтобы файл README отображался в верхней части страницы вашего профиля, вам необходимо сначала его настроить. Если вы уже знаете, как это сделать, вы можете пропустить этот шаг, однако для тех, кто не знаком с этим, на GitHub есть отличное руководство по этому вопросу.

Расширение точки md

Расширение .md известно как Markdown. Markdown — это инструмент преобразования текста в HTML для веб-писателей. Он позволяет вам писать в удобном для чтения и записи текстовом формате, а затем преобразовывать его в структурно допустимый XHTML или HTML. (Дерзкий огненный шар: Markdown)

Генераторы ридми

Мы будем использовать генератор readme для создания базового шаблона.

Лично я использовал два генератора ридми: GPRM и GitHub Profile Readme Generator. Оба генератора имеют свои плюсы и минусы, но, короче говоря, GPRM проще в использовании, поскольку он проведет вас через каждый шаг, тогда как GitHub Profile Readme Generator более продвинутый и гибкий.

Я буду использовать GitHub Profile Readme Generator, но вы можете использовать любой из них или даже поискать другой, поскольку мы будем использовать его только для создания шаблона, который можно улучшить позже.

Почти все генераторы имеют одинаковую схему. Они попросят вас предоставить Основную информацию › Инструменты, которые вы используете › Ваши социальные сети › Дополнения.

Основная информация

Обычно это включает ваше имя, краткое описание себя и информацию о том, что вы сейчас изучаете, или о проектах, над которыми вы сейчас работаете.

Инструменты, которые вы используете

Обычно вам придется выбирать различные инструменты, которые вы используете. В зависимости от генератора это может включать такие инструменты, как языки программирования, программное обеспечение и услуги.

Ваши социальные сети

Почти все генераторы будут запрашивать ваши социальные сети, которые позже будут преобразованы в ссылки или связанные кнопки в вашем файле readme на GitHub.

Дополнения

Это может быть или не быть шагом в зависимости от вашего генератора, но надстройки обычно включают значок подсчета посетителей, трофеи GitHub и карточку статистики профиля GitHub. Если он недоступен в используемом вами генераторе, вы можете проверить раздел «Полезные материалы» этой статьи, чтобы узнать, как добавить его вручную.

Добавляем его на GitHub

После предоставления всех деталей, которые нужны генератору, он сгенерирует некоторые тексты. В некоторых случаях он может даже сгенерировать для вас файл, который будет доступен для скачивания. Возьмите сгенерированные тексты и перейдите в свой репозиторий GitHub, имя которого совпадает с вашим именем пользователя GitHub (если у вас нет такого репозитория, создайте его, выполнив эти шаги).

В репозитории вы должны увидеть файл с именем README.md (если таких файлов нет, создайте его, нажав 'Добавить файл' › 'Создать новый файл". Назовите файл "README.md").

Откройте файл и нажмите кнопку редактирования (маленький карандаш). Вставьте сгенерированный текст в этот файл и нажмите «Применить изменения». И вуаля, теперь у вас есть красивый ридми GitHub, который должен быть виден в вашем профиле GitHub.

Просто шаблон

Помните, что сгенерированный контент — это всего лишь шаблон, вы можете свободно редактировать контент, чтобы сделать его уникальным для вас. Некоторое знание HTML облегчит редактирование файла, но не обязательно. Помните, что Google — ваш друг, и у этого друга есть ответ почти на все ваши проблемы.

Вы можете быстро просмотреть свои изменения после редактирования, нажав кнопку «Предварительный просмотр».

Некоторые полезные вещи

Спасибо

Большое спасибо за то, что потратили свое драгоценное время на эту статью. Я искренне надеюсь, что хоть чем-то вам помог. Нажмите на эту ссылку, если хотите найти меня.