From 1cfd0c8b036c7ea87eb45ee670c4ebe8c857fc0d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=9A=D0=BE=D1=88=D0=BA=D0=BE=D1=84=D0=BB=D0=B8=D0=BA?=
 =?UTF-8?q?=D1=82?= <121az348@gmail.com>
Date: Mon, 13 Apr 2026 07:43:46 +0000
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8=D1=82?=
 =?UTF-8?q?=D1=8C=20readme.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Кошкофликт <121az348@gmail.com>
---
 readme.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..44c9c53
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,44 @@
+# Raspberry Pi virus checker for USB volumes.
+## Сканер вирусов на USB флеш-накопителях на базе Raspberry Pi
+
+> **ВНИМАНИЕ!!!** Этот репозиторий создан _исключительно_ для практической части курсовой работы и по своей сути является форком репозитория [Thiflict/RPIUsbVirusScaner](https://git.ds1.thiflict.ru/Thiflict/RPIVirusScaner) (репозиторий может быть приватным на текущий момент). Это значит, что этот форк никак не будет развиваться, только в рамках курсовой работы. Развитие проекта вне курсовой работы будет происходить только в его оригинальном вышеупомянутом репозитории!
+
+Эта программа позволяет использовать одноплатный микрокомпьютер RaspberryPi как устройство для проверки флешек на вирусы.
+
+Аппаратные и программные требования:
+- RaspberryPi с поддержкой 40-контактного GPIO.
+- 1 Красный светодиод
+- 1 Жёлтый светодиод
+- 1 Зелёный светодиод
+- 1 тактовая кнопка _(теоретически, подойдёт и клавиатурный переключатель)_
+- 3 резистора номиналом от 220Ω до 330Ω _(зависит от желаемой яркости светодиодов, выше - тусклее)_
+- Провода-перемычки для подключения к пинам GPIO
+- Debian-based дистрибутив
+- Установленная программа для автоматического монтирования USB накопителей.
+- Для пользователей РФ необходимо использовать зеркала или иметь проксирование трафика через зарубежные IP-адреса, чтобы ClamAV мог исправно обновлять антивирусные базы.
+
+Подключение светодиодов и кнопки к GPIO:
+> - Анод красного светодиода: GPIO 22 (Физический пин 15)
+> - Катод красного светодиода: Любой из GND (Физические пины: 6, 9, 14, 20, 25, 30, 34, 39)
+
+> - Анод жёлтого светодиода: GPIO 27 (Физический пин 13)
+> - Катод жёлтого светодиода: Любой из GND (Физические пины: 6, 9, 14, 20, 25, 30, 34, 39)
+
+
+> - Анод зелёного светодиода: GPIO 17 (Физический пин 11)
+> - Катод зелёного светодиода: Любой из GND (Физические пины: 6, 9, 14, 20, 25, 30, 34, 39)
+
+
+> - Первый контакт тактовой кнопки: GPIO 24 (Физический пин 18)
+> - Второй контакт тактовой кнопки: Любой из GND (Физические пины: 6, 9, 14, 20, 25, 30, 34, 39)
+
+Для загрузки можно также воспользоваться скриптом установки. **(НЕ ТЕСТИРОВАН!)**
+Для этого его необходимо загрузить из релиза или из исходника, затем сделать его executable
+
+```bash
+sudo chmod +x install_script.sh
+```
+Затем, выполнить его от имени суперпользователя:
+```bash
+sudo ./install_script.sh
+```
\ No newline at end of file