README.md how to write correctly and what are the guidelines for writing?

Question

git

How to write correctly and what are the recommendations for writing README.md?
PS: Documentation
Online editor

Answer 1

Yes, write whatever you want, learn Markdown and style, your repository, your rules.
If something is not clear to people, they will open an issue and advise.
Here is an example of how yii is designed readme https://github.com/yiisoft/yii
Here is Laravel https://github.com/laravel/laravel

Answer 2

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

Answer 3

Disagree with

Yes, write whatever you want (c) Rikcon

It is necessary to convey to people not in what format to write and how to format, but the concept of this file.
It's well described here.

Excerpt from the article

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