From 957952901ba2d66d79674b1021e15f043b289e09 Mon Sep 17 00:00:00 2001
From: kromskii2 <146603192+kromskii2@users.noreply.github.com>
Date: Mon, 17 Jun 2024 16:50:17 +0700
Subject: [PATCH] Create README.md

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da0cb04
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Проект "E.D.I.T.H. - распознавание лиц с веб-камеры"
+
+![E.D.I.T.H.]
+
+## Описание проекта
+
+Проект E.D.I.T.H. (Even Dead, I'm The Hero) посвящен распознаванию лиц с использованием веб-камеры. Он назван в честь искусственного интеллекта из фильма "Человек-паук: Вдали от дома", который предоставляет доступ к спутниковой сети Stark Industries.
+
+### Возможности
+
+1. **Распознавание лиц**: Программа сканирует видеопоток с веб-камеры и автоматически обнаруживает лица на кадрах.
+2. **Сохранение лиц**: Обнаруженные лица сохраняются в отдельную папку "faces" с уникальным временным отметками и номером лица.
+3. **Уникальность лиц**: Проверка на уникальность лиц перед сохранением осуществляется с помощью хэширования изображений лиц.
+4. **Интерфейс**: В реальном времени отображает видеопоток с выделенными прямоугольниками вокруг обнаруженных лиц.
+
+## Настройка проекта
+
+### Установка зависимостей
+
+Для корректной работы проекта требуется Python 3.x и следующие библиотеки:
+
+```bash
+pip install opencv-python Pillow imagehash
+```
+
+### Подготовка к запуску
+
+1. **Хэр-каскады OpenCV**: Убедитесь, что у вас есть файл `haarcascade_frontalface_default.xml`, который используется для обнаружения лиц. Он поставляется вместе с библиотекой OpenCV.
+   
+2. **Создание папки для лиц**: Программа автоматически создаст папку "faces" в корневом каталоге проекта, если её нет.
+
+## Первый запуск
+
+1. Запустите скрипт `face_recognition.py`.
+2. При первом запуске программа запросит доступ к веб-камере.
+3. Для выхода нажмите клавишу 'q'.
+
+## Лицензия
+
+Этот проект лицензируется по лицензии [MIT](LICENSE).