Какая информация должна быть в github README.md?

Какую информацию вы ожидаете увидеть в github README?

Должно ли все идти в README? т.е.

Введение
Установка
Версии
Гид пользователя
Реализация
тестирование
Связанные ресурсы

Или вы просто должны поместить некоторые вещи в README (Введение, Установка, Версии), а другую информацию лучше всего поместить в вики Github?

documentation github

— user86834
источник

Я бы тоже поставил условия лицензии

— py_script

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

— Кит Томпсон

На этот вопрос очень подробный / хороший ответ здесь: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Родриго Граса

Я ожидаю увидеть введение и краткий обзор. Там должно быть что-то, чтобы убедить меня, что проект решает конкретную проблему. После прочтения README я должен знать достаточно информации, чтобы знать, что делает проект, что ему требуется, как его построить и как его использовать. Эта информация не обязательно должна быть в README, но ссылки на эту информацию должны быть.

— Брайан Оукли
источник

+1 для краткости. Не говорите «README», а затем добавьте мусор, который не нужно читать.

— Корей Хинтон