diff --git a/README.md b/README.md index e634196..ac40d67 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # TelegramNewsBot -Берет новости из базы данных сайта кафедры и отправляет через бота новости в канал в Телеграме \ No newline at end of file +Берет новости из базы данных сайта кафедры и отправляет через бота новости в канал в Телеграме + +## Установка + +Использование данного скрипта планируется на ОС Linux с использованием таймера для периодичного запуска. + +1. Установка необходимого ПО: +```bash +apt install git mc curl python3-pip python3-venv +``` +2. Клонировать проект в необходимою папку (например в /opt): +```bash +git clone https://git.athene.tech/sam/TelegramNewsBot.git +``` +3. Создать виртуальное окружение Python: +```bash +python3 -m venv virt_env +``` +4. Установить необходимые драйвера для работы ODBC с https://docs.microsoft.com/ru-ru/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server: +5. Установить необходимые зависимости в виртуальное окружение: +```bash +source virt_env/bin/activate +pip install -r requirements.txt +``` \ No newline at end of file