Я настоятельно рекомендую разместить видео на веб-сайте проекта, созданном с помощью GitHub Pages вместо readme, как описано в VonC's answer ; это будет намного лучше, чем любая из этих идей. Но если вам нужно быстрое решение, как и мне, вот несколько советов.
Используйте подарок
См. ответ aloisdg , результат потрясающий, GIF-файлы отображаются на readme github;)
Использование изображения с видео-плеера
Вы можете заставить пользователя думать, что видео находится на странице readme с картинкой. Звучит как рекламный трюк, он не идеален, но работает и забавен;).
Пример:
[![Watch the video](https://i.imgur.com/vKb2F1B.png)](https://youtu.be/vt5fpE0bzSY)
Результат:
Использовать предварительный просмотр YouTube
Вы также можете использовать изображение, созданное YouTube для вашего видео.
Для URL YouTube в виде:
https://www.youtube.com/watch?v=<VIDEO ID>
https://youtu.be/<VIDEO URL>
URL-адреса предварительного просмотра имеют вид:
https://img.youtube.com/vi/<VIDEO ID>/maxresdefault.jpg
https://img.youtube.com/vi/<VIDEO ID>/hqdefault.jpg
Пример:
[![Watch the video](https://img.youtube.com/vi/T-D1KVIuvjA/maxresdefault.jpg)](https://youtu.be/T-D1KVIuvjA)
Результат:
Использовать asciinema
Если ваш вариант использования работает в терминале, asciinema позволяет записывать сеанс терминала и имеет хорошее вложение уценки.
Нажмите кнопку "Поделиться" и скопируйте фрагмент уценки.
Пример: * * тысяча пятьдесят-семь
[![asciicast](https://asciinema.org/a/113463.png)](https://asciinema.org/a/113463)
Результат: