From c4b14877fd65a5229a6bdaf7a0e1710e2d5f31e5 Mon Sep 17 00:00:00 2001 From: Whyverum Date: Wed, 18 Dec 2024 07:13:13 +0700 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=BD=D1=81=D1=82=D1=80=D1=83=D0=BA?= =?UTF-8?q?=D1=86=D0=B8=D1=8F=20=D0=BA=20=D0=BF=D1=80=D0=BE=D0=B5=D0=BA?= =?UTF-8?q?=D1=82=D1=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..62927ab --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +## PRIMO_aiogram_bot + +--- +## Приветствие + +Здравствуй, **дорогой пользователь**! +Меня зовут *Лейн*, я думаю, мы вряд ли с Вами знакомы, +но это и неважно. + +Этот проект нужен для того, чтобы каждый мог +создать своего *бота* на основе **Aiogram**. +Этот **шаблон** позволит Вам получить все возможные функции: от создания *клавиатур*, +до *логгеров* или *машины состояний*. + +--- +## Навигация: + +- ### [Приветствие](#Приветствие) +- ### [Первый запуск бота](#Запуск) +- ### [Его возможности](#Возможности) +- ### [Прочее](#Прочее) +- ### [Задачи:](#Задачи) +- ### [Прощание](#Прощание) + +--- +## Запуск + +Так что, давайте поговорим немного о самом проекте. +Для начала, проект, что Вы получили с **GitHub**, имеет небольшую особенность +для Windows-пользователей, а именно файл **project.bat**. +Активировав этот файл через *консоль* с помощью команды: +**start project**. +Вы сможете установить локальное окружение, обновить библиотеки и запустить бота. Вам +не понадобиться думать и настраивать бота. Все, что Вам необходимо - это иметь +установленным **Python 3.13** и **GIT**. После этого он автоматически: + +- создаст локальное окружение +- установит все необходимые библиотеки +- создаст локальный **GIT** репозиторий +- запустит сам **main.py** (*основной файл бота*) + +--- +## Возможности + +Поэтому, Вы уже получите возможность пользоваться системой **GIT**. Также из плюсов можно +выделить многое другое, например: +- Работа с репозиториями и системой GIT +- Удобное логирование с помощью loguru +- Проверка на ошибки и удобный вывод их в окно консоли +- Работа с базами данных (в разработке) +- И т.д... + + +--- +## Задачи: + +- Сделать адекватную базу данных +- Сделать проверки на ошибки, и не правильный тип данных, +а главное, чтобы это логгировалось консолью +- Сделать отдельный логгер под ошибки в файл +- Скачивание аватарок каналов + доделать для чатов +- Доделать команды /ban, /kik, /mute +- И т.д. + +--- +## Прощание + +Я очень рад, что Вы пользуетесь этим проектом, надеюсь, +что в дальнейшем буду улучшать его все дальше и дальше. +Удачи Вам, и ,конечно же... + +***Вперед за Истиной, Дорогой Друг!*** + +- **Verum.**