Создание README

Введение в основы GitHub

Jasmin Ludolf

Content Developer, DataCamp

Редактирование README

Редактирование README

Редактирование README

Markdown

Редактирование и предпросмотр

Заголовки

Заголовки

Заголовки

Форматирование текста

Гиперссылки

Гиперссылки

Изображения

Написание README

• Должен быть информативным
  • Любой должен понять суть проекта
• Перечислять содержимое репозитория
• Понятно объяснять проект другим

Основы README

• Название
• Описание технологии
  • Почему?
• Описание процесса
  • Почему?
• Оглавление

Дополнительные разделы README

• История возникновения проекта
• Мотивация
• Ограничения
• Трудности
• Какую проблему решает проект
• Предполагаемое применение
• Благодарности

Давайте потренируемся!

Введение в основы GitHub