Как Оформить README-Файл На GitHub | Основы Markdown

Описание

Когда кто-то открывает ваш проект на GitHub первое, что попадётся ему на глаза это README файл. README это файл, как правило с расширением md реже txt, который содержит информацию о том или ином программном продукте: библиотеке, фреймворке, мини-скриптике или полноценном проприетарном ПО. В этот файл помещают краткое описание о проекте, что это, зачем он нужен, документацию, примеры использования, требования,
имена авторов программы, историю версий, примечания и многое другое. Поэтому не трудно догадаться что README является лицом вашего проекта.
Поэтому грамотно оформленный, качественный README может выставить вас в выгодном свете и произвести хорошее первое впечатление, как на случайных пользователей, так и на потенциальных работодателей, которые будту просматривать ваши проекты. В этом видео мы познакомимся с основами синтаксиса Markdown, а также я расскажу, как оформить README файл на Github.

✔ Основы Jupyter Notebook (Python): https://www.youtube.com/watch?v=s0q2GpcYxo4
✔ Как Добавить Свлю Библиотеку На PyPi: https://www.youtube.com/watch?v=ji5nkIiGHrU
✔ VS Code Для Python: https://www.youtube.com/watch?v=OysRwfbHa1A
✔ Instagram:https://www.instagram.com/py_lounge
✔ Ссылка на группу ВКонтакте: https://vk.com/pylounge
✔ Канал PyLounge: https://www.youtube.com/channel/UCru5FZQN_Xa0tKfrBqUIcng
✔ По вопросам сотрудничества и предложений: peoplesdreamer@gmail.ru
✔ Music: https://www.free-stock-music.com
✔ Кружку (и не только) можно найти на Apolshop: https://apolshop.ru

Материалы из видео:
✔ GitHub: https://github.com/
✔ Скачать VS Code: https://code.visualstudio.com/
✔ Расширение Markdown All in One https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one#review-details
✔ Скачать Git: https://git-scm.com/downloads
✔ Шпаргалка (Cheatsheet) по Markdown: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
✔ Интерактивный туториал по Markdown: https://commonmark.org/help/tutorial/
✔ Shields.io: https://shields.io/
✔ Список поддерживаемых эмоджи: https://github.com/GnuriaN/format-README/blob/master/emoji.md
✔ Мой модуль clubhouse_api: https://github.com/Peopl3s/club-house-api

Привет! Я долго занимаюсь программированием, в частности программирование на языке Python. Я много чего узнал за это время, и мне есть, чем поделиться со зрителями моего канала.
Здесь выходят разнообразные ролики, касающиеся IT-тематики и программирования.
Подписывайся, будем узнавать что-то новое и работать вместе! Погнали!

#markdown #github #pylounge #ityoutubersru #readme