0.6.1 Официальный шаблон, который позволяет управлять всем, что необходимо
This commit is contained in:
74
Documentation/README.md
Normal file
74
Documentation/README.md
Normal file
@@ -0,0 +1,74 @@
|
||||
## PRIMO_aiogram_bot
|
||||
|
||||
---
|
||||
## Приветствие
|
||||
|
||||
Здравствуй, <u>**дорогой пользователь**</u>!
|
||||
Меня зовут *Лейн*, я думаю, мы вряд ли с Вами знакомы,
|
||||
но это и неважно.
|
||||
|
||||
Этот проект нужен для того, чтобы каждый мог
|
||||
создать своего *бота* на основе **Aiogram**.
|
||||
Этот **шаблон** позволит Вам получить все возможные функции: от создания *клавиатур*,
|
||||
до *логгеров* или *машины состояний*.
|
||||
|
||||
---
|
||||
## Навигация:
|
||||
|
||||
- ### [Приветствие](#Приветствие)
|
||||
- ### [Первый запуск бота](#Запуск)
|
||||
- ### [Его возможности](#Возможности)
|
||||
- ### [Прочее](#Прочее)
|
||||
- ### [Задачи:](#Задачи)
|
||||
- ### [Прощание](#Прощание)
|
||||
|
||||
---
|
||||
## Запуск
|
||||
|
||||
Так что, давайте поговорим немного о самом проекте.
|
||||
Для начала, проект, что Вы получили с **GitHub**, имеет небольшую особенность
|
||||
для Windows-пользователей, а именно файл **project.bat**.
|
||||
Активировав этот файл через *консоль* с помощью команды:
|
||||
**start project**.
|
||||
Вы сможете установить локальное окружение, обновить библиотеки и запустить бота. Вам
|
||||
не понадобиться думать и настраивать бота. Все, что Вам необходимо - это иметь
|
||||
установленным **Python 3.13** и **GIT**. После этого он автоматически:
|
||||
|
||||
- создаст локальное окружение
|
||||
- установит все необходимые библиотеки
|
||||
- создаст локальный **GIT** репозиторий
|
||||
- запустит сам **main.py** (*основной файл бота*)
|
||||
|
||||
---
|
||||
## Возможности
|
||||
|
||||
Поэтому, Вы уже получите возможность пользоваться системой **GIT**. Также из плюсов можно
|
||||
выделить многое другое, например:
|
||||
- Работа с репозиториями и системой GIT
|
||||
- Удобное логирование с помощью loguru
|
||||
- Проверка на ошибки и удобный вывод их в окно консоли
|
||||
- Работа с базами данных (в разработке)
|
||||
- И т.д...
|
||||
|
||||
|
||||
---
|
||||
## Задачи:
|
||||
|
||||
- Сделать адекватную базу данных
|
||||
- Сделать проверки на ошибки, и не правильный тип данных,
|
||||
а главное, чтобы это логгировалось консолью
|
||||
- Сделать отдельный логгер под ошибки в файл
|
||||
- Скачивание аватарок каналов + доделать для чатов
|
||||
- Доделать команды /ban, /kik, /mute
|
||||
- И т.д.
|
||||
|
||||
---
|
||||
## Прощание
|
||||
|
||||
Я очень рад, что Вы пользуетесь этим проектом, надеюсь,
|
||||
что в дальнейшем буду улучшать его все дальше и дальше.
|
||||
Удачи Вам, и ,конечно же...
|
||||
|
||||
***Вперед за Истиной, Дорогой Друг!***
|
||||
|
||||
- **Verum.**
|
||||
Reference in New Issue
Block a user