Задать вопрос
slavikse
@slavikse
git

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

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

PS: Документация
Онлайн редактор
  • Вопрос задан
  • 76523 просмотра
Комментировать
Подписаться 9 Простой Комментировать
Помогут разобраться в теме Все курсы
  • Учебный центр IBS
    DEV-007 Введение в систему контроля версий Git
    1 неделя
    Далее
  • ProductStar
    Python + Flask + Git: веб-разработка с нуля
    2 месяца
    Далее
  • Stepik
    Git (система контроля версий)
    1 неделя
    Далее
Пригласить эксперта
Ответы на вопрос 2
@entermix
webdesign.ru.net/article/pravila-oformleniya-fayla...
Ответ написан
Комментировать
Комментировать
trec
@trec
Не согласен с
Да пишите как хотите (c) Rikcon

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

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

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

Похожие вопросы
Вакансии с Хабр Карьеры
PHP-разработчик
Остров Сокровищ
от 180 000 до 250 000 ₽
React разработчик
ITK academy • Нижний Новгород
от 80 000 до 120 000 ₽
Fullstack-разработчик сайтов laravel
WEB ALTERNATIVE
от 65 000 ₽
Ещё вакансии