Общая информация о проекте - что он из себя представляет, зачем нужен, главные достоинства.
Инструкция по установке "для чайников":
установите python с сайта...
склонируйте репозиторий (в итоговой версии нужно будет сделать релиз, чтобы не нужно было клонировать весь репозиторий, но пока можно и так), это делается так-то...
запустите python main.py
Инструкция по использованию. Клавиши, управление, примеры (желательно добавить скриншоты), фичи.
Информация, куда писать предложения по улучшению или сообщения о багах (в issues, конечно, куда же ещё).
Добавьте информацию в файл README.
Что в нем должно быть:
Общая информация о проекте - что он из себя представляет, зачем нужен, главные достоинства.
Инструкция по установке "для чайников":
установите python с сайта...
склонируйте репозиторий (в итоговой версии нужно будет сделать релиз, чтобы не нужно было клонировать весь репозиторий, но пока можно и так), это делается так-то...
запустите python main.py
Инструкция по использованию. Клавиши, управление, примеры (желательно добавить скриншоты), фичи.
Информация, куда писать предложения по улучшению или сообщения о багах (в issues, конечно, куда же ещё).