Задать вопрос
JimmiJanger
@JimmiJanger
Любопытный активист, под маской ленивого нуба.
github

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

Я тут копался в проектах других людей, и смотрел как у них описан README
Кто-то пишет просто:
  1. npm install
  2. npm run serve

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

В общем, есть какие-то "базовые" правила заполнения "README.md" ?
Спасибо!
  • Вопрос задан
  • 2519 просмотров
Комментировать
Подписаться 1 Простой Комментировать
Помогут разобраться в теме Все курсы
  • Нетология
    Python-разработчик: расширенный курс + нейросети
    12 месяцев
    Далее
  • Академия Эдюсон
    Python-разработчик + ИИ
    9 месяцев
    Далее
  • ProductStar × РБК
    Профессия: Python-разработчик + ИИ
    8 месяцев
    Далее
Решения вопроса 1
megakor
@megakor
Senior Go developer at VK Video
Каких-то правил нет.

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

Ваш репозиторий - ваши правила, делайте как хотите.
Ответ написан
Комментировать
Комментировать
Пригласить эксперта
Ответы на вопрос 1
honor8
@honor8
Принципы быстродействия VBA в описании
Правил нет, но попытку стандартизации можно найти. Например:
https://github.com/RichardLitt/standard-readme
Ответ написан
Комментировать
Комментировать
Ваш ответ на вопрос

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

Похожие вопросы