Что писать в «README.md» (GitHub)?

Question

[Тимофей Михайлов]

Я тут копался в проектах других людей, и смотрел как у них описан README
Кто-то пишет просто:

1. npm install
   
2. npm run serve
   

Кто-то начинает с git clone ...
А некоторые вообще, ничего этого не пишут, у них просто куча текста с картинками ...

В общем, есть какие-то "базовые" правила заполнения "README.md" ?
Спасибо!

Answer 1

[Роман Сарваров]

Каких-то правил нет.

Обычно указывают:
1. Установка
2. Описание
3. Документация
4. Авторы
5. Лицензия

Ваш репозиторий - ваши правила, делайте как хотите.

Answer 2

[h8nor]

Правил нет, но попытку стандартизации можно найти. Например:
https://github.com/RichardLitt/standard-readme