From 2575705ffc01906ea9911b44a3fa706bbcd215e0 Mon Sep 17 00:00:00 2001
From: IPKlimov <ipklimov@mai.education>
Date: Tue, 14 May 2024 13:42:49 +0000
Subject: [PATCH] Update README.md

---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)

diff --git a/README.md b/README.md
index e69de29..a42fdf2 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,66 @@
+
+#ИЗВИНИТЕ ЗА МАТ
+
+## Описание
+
+Этот проект разработан для загрузки и обработки видео файлов (MP4) и файлов шахматных партий (PGN) с использованием библиотек `Streamlit`, 'MoviePy'. Основная функция программы заключается в поиске и обработке интересных моментов в шахматных партиях и озвучке с помощью сервиса elevenlabs.
+
+## Функционал
+
+- Загрузка файлов MP4 и PGN через пользовательский интерфейс. Указываем время фактического начала партии(то есть первого хода)
+- Интеграция с моделью GPT-4 для анализа шахматных партий.
+- Озвучка при помощи elevenlabs.io
+- Обрезка и обработка видеофрагментов по заданным временным меткам.
+- Вывод результатов в видео проигрывателе на веб-странице.
+
+## Установка и запуск
+
+1. **Клонировать репозиторий:**
+   ```
+   git clone [URL репозитория]
+   cd [название папки репозитория]
+```
+2. Установка зависимостей:
+MoviePy автоматически использует FFmpeg для обработки видеофайлов, но иногда требуется установить FFmpeg отдельно.
+
+```
+pip install moviepy
+```
+Для Windows:
+
+Скачайте последнюю версию FFmpeg с официального сайта FFmpeg.
+Распакуйте архив в удобное место.
+Добавьте путь к исполняемым файлам FFmpeg (bin директория) в переменную среды PATH.
+
+Для macOS:
+
+Установите FFmpeg с помощью Homebrew:
+bash
+Копировать код
+brew install ffmpeg
+
+Для Linux:
+
+Установите FFmpeg через менеджер пакетов вашего дистрибутива:
+bash
+Копировать код
+sudo apt update
+sudo apt install ffmpeg  # Для Ubuntu/Debian
+sudo dnf install ffmpeg  # Для Fedora
+
+Установка и библиотека openAi
+```
+pip install openai
+
+```
+
+
+Использование
+После запуска приложения откройте ваш браузер по адресу http://localhost:8501. Используйте интерфейс для загрузки файлов и ввода необходимых данных для обработки видео.
+
+Главная страница
+Загрузка файлов: Выберите файлы MP4 и PGN для загрузки.
+Ввод времени: Укажите время начала интересного момента в видео.
+Обработка: Нажмите кнопку "Обработать видео" для начала обработки.
+Страница просмотра видео
+Просмотр видео: На этой странице можно просмотреть результаты обработки.
-- 
GitLab