diff --git a/README.md b/README.md index 48740a5..84e34c7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # Заучка -Приложение для эффективного заучивания стихов. +Приложение для эффективного заучивания стихов.\ Сделано в рамках проекта для Лицея Академии Яндекса (2 курс). +## Запуск +* Штатный режим\ +В репозитории лежит файл .exe с приложением +(если не лежит, значит я его ещё не сделал). Просто запускаете его, и пользуетесь. +* Dev-режим + 1. Запустите терминал в той же папке, в которой находится проект + 2. Создайте и запустите виртуальное окружение следующими командами: + ``` + python -m venv venv + venv/scripts/activate + ``` + 3. Установите все зависимости, используя команду\ + `pip install -r requirements.txt` + 4. Запустите файл main.py