← Все вопросы

Как читать README на гитхабе, если он на английском и непонятно с чего начать?

Задан 12 месяцев назад1.1к просмотров1 ответ
7

Нашёл на GitHub полезную библиотеку, открыл README — там здоровенная страница на английском. Не понимаю, что читать в первую очередь и что вообще важно, а что можно пропустить. Подскажите?

1 ответ

11
✓ Принятый ответ — помог автору

У README почти всегда одинаковая структура, и тебе как новичку нужны только 3 раздела — остальное смело пропускай:

  1. Сверху — описание (1-2 абзаца «что это и зачем»). Прочитай, чтобы понять, та ли это библиотека.
  2. Installation / Getting Started — как установить и запустить. Тут будет команда вроде pip install ... — это самое важное, копируй её.
  3. Usage / Examples — примеры использования. Тут код, который можно скопировать и попробовать. Часто понятен вообще без чтения текста.

Что можно пропустить на старте: Contributing (как помогать проекту), License (юридическое), Changelog (история версий), Badges (картинки-значки сверху). Это для продвинутых.

Лайфхак: жми Ctrl+F и ищи слово example или install — сразу прыгнешь к нужному. Не надо читать README целиком сверху вниз.

Ваш ответ

, чтобы ответить на вопрос.