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

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