Найти в Дзене
troff_webdev
24 подписчика

GitHub - оформление README.md

1327
~1 мин
Файл README.md — это руководство, которое дает пользователям подробное описание проекта, а так же является первым, на что обращает внимание читатель заходя в репозиторий, поэтому он должен быть кратким, но информативным. Я предлагаю использовать мой шаблон как базу, которую со временем можно прокачивать. Структура файла README.md: Файл README.md написан в разметке Markdown. Шпаргалка по синтаксису MarkDown - тык. Мой шаблон - тык. Алгоритм реализации: Несколько источников по теме создания README.md - тык, тык, тык. Шаблон от которого я отталкивался - тык. Мой телеграм канал - troff_webdev

Файл README.md — это руководство, которое дает пользователям подробное описание проекта, а так же является первым, на что обращает внимание читатель заходя в репозиторий, поэтому он должен быть кратким, но информативным.

Я предлагаю использовать мой шаблон как базу, которую со временем можно прокачивать.

Структура файла README.md:

  1. Название проекта.
  2. Описание проекта.
  3. Ссылка на сайт.
  4. Скрин сайта.
  5. Стек технологий, мотивация.
  6. Список задач To do.
  7. Команда.
  8. Источники.
Скриншот "До"
Скриншот "До"
Скриншот "После"
Скриншот "После"
Файл README.md написан в разметке Markdown.
Шпаргалка по синтаксису MarkDown - тык.

Мой шаблон - тык.

Алгоритм реализации:

  • Открываем README.md
  • Нажимаем Ctrl+Shift+V (linux) чтобы увидеть файл в режиме предварительного просмотра.
  • Можно использовать онлайн редактор разметки - Dillinger.
-4
  • Копируем мой шаблон, меняем данные. ( аналогично гайду - Оформление профиля GitHub)
  • Сайт для получения ссылки на изображение - Imgbb, загружаем свой скрин, меняем ссылку в разметке.
  • Используя генератор bages - Shields, можем создать свои бейджи (Simpleicons).
  • Можем добавить любой код из Шаблонов - Awesome readme.
Несколько источников по теме создания README.md - тык, тык, тык.
Шаблон от которого я отталкивался - тык.

Мой телеграм канал - troff_webdev