🖥 Хотите сделать красивый README на GitHub?

Я вообще обожаю описывать Readme файл и кайфую, когда всё красиво, чётко и ясно. Мне трудно понять людей, которые не ведут документируют собственные проекты, ведь это помогает не только другим, но и автору кода!

Например, недавно я создавала первый проект с Docker, Jenkins и генерацией отчета тестирования. Захотела сделать всё «по-умному», чтобы джобы сами работали и всё в этом духе. Так вот, мой Readme файл пригодился не только девопсу разобраться с моим кодом и помочь, но и мне! Потому что все эти команды запомнить не очень просто, а благодаря документации всё становится структурированным (это моё личное наслаждение)

Я пишу Readme по всем канонам: с тайтлами, изображениями, блоками кода, сносками и так далее. И вам советую! Потому что таким образом вашу документацию будет проще читать и использовать.

А возвращаясь к GitHub README файлу, здесь вообще большое пространство для фантазии. Потому что это ваша презентация, и вы имеете право писать всё, что угодно, в любом стиле.

А именно поэтому я хочу поделиться подборкой полезных ресурсов, которые помогут сделать вашу «визитную карточку» на GitHub более привлекательной:

▫️awesome-github-profile-readme
▫️creative-profile-readme
▫️skill-icons
▫️github-readme-stats
▫️cicirello/user-statistician
▫️dec0dOS/amazing-github-template
▫️markdown-badges

(источник)