doc: написал README.md

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`