README.md как правильно писать и какие рекомендации по написанию?

Question

[Вячеслав Лебедев]

Как правильно писать и какие рекомендации по написанию README.md?

PS: Документация
Онлайн редактор

Answer 1

[entermix]

webdesign.ru.net/article/pravila-oformleniya-fayla...

Answer 2

[Дмитрий]

Не согласен с

Да пишите как хотите (c) Rikcon

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

Выдержка из статьи

Хороший README расскажет вам, как пользоваться этим проектом и как принять в нем участие. Он продает проект, но дает знать посетителям, что, возможно, им нужно другое решение. Таким образом этот файл как бы выражает уважение автора к читателям и экономит их время.