Яка інформація повинна бути в github README.md?

Яку інформацію ви б очікували побачити в github README?

Чи повинно все йти в ПОЧАТКУ? тобто

Вступ
Установка
Версії
Керівництво користувача
Впровадження
Тестування
Суміжні ресурси

Або вам слід просто помістити певні речі у README (Вступ, Встановлення, Версії), а інша інформація найкраще міститись у вікі Github?

documentation github

— user86834
джерело

Я також ставлю ліцензійні умови

— py_script

Якщо говорити надто загально, то має бути достатньо інформації, щоб сказати мені, чи корисний мені проект, якщо все, що я знаю про нього, це ім'я. Не припускайте нічого про те, як читач знайшов це.

— Кіт Томпсон

На це питання є дуже детальна / хороша відповідь тут: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Rodrigo Graça

Я очікую побачити вступ та короткий огляд. Там має бути щось, щоб переконати мене, що проект вирішує конкретну проблему. Прочитавши README, я повинен знати достатньо інформації, щоб знати, що робить проект, що йому потрібно, як його скласти та як його використовувати. Ця інформація не всі повинна містити README, але посилання на цю інформацію повинні бути.

— Брайан Оуклі
джерело

+1 для короткого. Не кажіть "README", а потім кладіть купу сміття, яке не потрібно читати.

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