From 180b9f0a713e72310e2c52ec1b404b267fd21b26 Mon Sep 17 00:00:00 2001
From: andrei <skirchenko@diakont.com>
Date: Sat, 16 Nov 2024 16:39:49 +0300
Subject: [PATCH] =?UTF-8?q?doc:=20=D0=BD=D0=B0=D0=BF=D0=B8=D1=81=D0=B0?=
 =?UTF-8?q?=D0=BB=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
index e69de29..49f991b 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,30 @@
+# Описание
+ПО TraceDemo предназначено для отображения диаграмм ТСК (только ТСК!) в реальном времени в рамках демонстрации работы системы.
+
+# Настройка перед запуском
+Для настройки ПО в каталоге `config` расположен файл: `config.json`.
+
+## `config.json` 
+
+Параметры:
+- trace_storage_path: путь к каталогу на локальной машине пользователя, в котором ищутся графики для отображения в формате строки,
+- monitor_update_period: период в мс, с которым проверяется содержимое каталога `trace_storage_path`,
+
+
+Пример заполнения настроек для подключения к ТСК:
+
+```json
+{
+  "trace_storage_path": "/home/andrei/Desktop/bla",
+  "monitor_update_period": 100
+}
+```
+
+# Запуск
+## Подготовка
+1. Создать виртуальное окружение внутри корневого каталога проекта
+2. Активировать виртуальное окружение
+3. Установить зависимости из `requirements.txt`
+## Запуск
+1. Убедиться, что виртуальное окружение активировано
+2. Выполнить в терминале `python3 src/main.py`
\ No newline at end of file