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

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

Материалы из видео:

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

#markdown #github #pylounge #ityoutubersru #readme

[fc-cxgt]

Начинается с 3:23 . Слушать при 1.25x минимум

[xmdnx]

в нумерованных списках не обязательно указывать номер элемента. Достаточно просто цифру поставить. например:

1. Первый элемент
1. Второй элемент
1. Третий элемент

Что срендерится в:
1. Первый элемент
2. Второй элемент
3. Третий элемент

Таким образом можно без проблем менять элементы списка не переписывая постоянно номера и не тратя на это время)

[ruslankhairullin]

Шикарное обучающее видео, большое спасибо!

[rhythmicpulse]

Хороший ролик, качественный. Про твой канал узнал после конкурса Соера.

[Good_BorisAV]

_Будьте здоровы!_
_Спасибо за информацию, было очень познавательно и интересно._ 🤔 👍

[Джин_Грин]

Спасибо, добрый человек.
Подписался))

[dmitruz]

Я все делаю также сохраняю репозиторий, пушу егоно на главной странице ничего не закрепилось. Мой Редми просто лежит в репозиторие и все. Его нет на главной странице профиля

[sergeikrasnovskii]

Спасибо большое за урок, а то никак не мог понять с чего надо начинать readme !

[Aribban]

Скажи пожалуйста как ты такой фон сделал или это просто живые обои на рабочем столе, а сам VSC у тебя прозрачный

[snowlue]

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

[seregavodolaz]

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

[arsen]

кто нибудь подскажите какая у него тема стоит

[АлександрКучеренко-йь]

нахрена логитипов на экран понаставили, не видно что нажимаете

[-D.K.-]

Брат я смотрю в 2023. Я не разбираюсь в SHIELDS IO и норм туториала нет сделай плиз