Глава 23 · Часть III · Создаём Python-проект

Первый README проекта

README отвечает на вопросы «что это?» и «как запустить?» ещё до того, как человек откроет код.

README — первый файл, который видит человек, открывший репозиторий: GitHub автоматически показывает его содержимое на главной странице проекта. В клонированном репозитории README.md уже существует и уже закоммичен — это часть стартового коммита chore: initial project scaffold, который был показан в предыдущем разделе. Сейчас он совсем короткий:

# SafeSort

SafeSort — программа для безопасной сортировки файлов по папкам.

Раз файл уже отслеживается Git, git status в чистом рабочем дереве ничего не покажет — нечего добавлять и нечего коммитить. Интересное начнётся, когда в файл внесут изменения: именно так README и растёт по ходу главы — дополняется разделами, а не переписывается с нуля. Добавим первый такой раздел:

# SafeSort

SafeSort — программа для безопасной сортировки файлов по папкам.

## Установка

pip install -e .

git diff показывает построчную разницу перед коммитом, git status — что именно изменилось с последнего коммита. По мере того как в проекте появляются установка, команды и тесты, в README добавятся такие же короткие разделы Usage и Tests. Полный README проекта, уже дополненный: projects/python/safesort/README.md.