Документация проекта Хороший README отвечает на пять вопросов до первого запуска: что делает проект, для кого он предназначен, какие требования нужны, какими точными командами получить рабочий результат и где искать помощь. Проверяйте документ в чистом клоне на машине, где нет скрытых настроек автора. # Название и один точный абзац ## Быстрый старт ## Требования и версии ## Настройка окружения ## Пример использования ## Проверка результата ## Типовые ошибки ## Документация, помощь, вклад и лицензия Порядок важнее красоты...