aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhuker667 <huker@tuta.io>2026-05-22 19:34:48 +0300
committerhuker667 <huker@tuta.io>2026-05-22 19:34:48 +0300
commitb027361586f776292260afff871c85b05359cf3d (patch)
treecd6b18db73c162292a903090b85a0f19e1fbf743 /README.md
downloaduzbekgpt-b027361586f776292260afff871c85b05359cf3d.tar.gz
uzbekgpt-b027361586f776292260afff871c85b05359cf3d.tar.bz2
uzbekgpt-b027361586f776292260afff871c85b05359cf3d.zip
first commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..72c5132
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# UzbekGPT
+**UzbekGPT** — это шуточный ИИ-ассистент в виде Telegram-бота, который немного узбек ✅✅
+Он может работать через 2 хуйни OpenAI (Ollama, OpenAI).
+Ollama совместима с OpenAI модулем, поэтому через него сделана (потому что я ебал его библиотеку на termux).
+
+## Запуск бота
+1. В файле `config.py` укажите модели OPENAI_MODELS (для своего сервера) и OLLAMA_MODELS (для олламы).
+2. Создайте файл `.env` и установите важные переменные по типу `API_TOKEN` и т.д. для всех провайдеров ии.
+3. Установите зависимости Python:
+ ```bash
+ pip install -r requirements.txt
+ ```
+4. Запустите UzbekGPT:
+ ```bash
+ python main.py
+ ```
+## Использование
+- `/start` — запускает бота и показывает приветственное сообщение.
+- `/clear` — очищает текущий контекст.
+- `/settings` — настройка.
+- `/prompt` — просмотр системного промпта.
+- `/image` — генерация uz-изображений.
+
+## Ограничения
+- Контекст ограничен числом сообщений. Лимит можно изменить через переменную `MAX_CONTEXT` (по умолчанию 5).
+- Стриминг ответа ИИ адекватно работает на версии Telegram для Android 12.5.2 и Telegram Desktop 6.3.4.
+- Длина промпта пользователя тоже ограничена определённым количеством символов в переменной `MAX_PROMPT` (по умолчанию 2000).