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

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

PS: Документация
Онлайн редактор
  • Вопрос задан
  • 67826 просмотров
Решения вопроса 1
Rikcon
@Rikcon
Да пишите как хотите, учите Markdown и стилизируйте, ваш репозиторий - ваши правила.
Если что-то людям будет не понятно откроют issue и посоветуют.

Вот пример как у yii оформлен readme https://github.com/yiisoft/yii
Вот Laravel https://github.com/laravel/laravel
Ответ написан
Пригласить эксперта
Ответы на вопрос 2
Комментировать
Не согласен с
Да пишите как хотите (c) Rikcon

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

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

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы