Update README.md

README.md

@@ -1,2 +1,23 @@
 # plumbing-system-router
 Plumbing system router
+Программа разработана в рамках хакатона "Лидеры цифровой трансформации 2023".
+Задача № 8 "СЕРВИС ГЕНЕРАЦИИ ТРАССЫ СИСТЕМЫ ВОДООТВЕДЕНИЯ"
+https://leaders2023.innoagency.ru/task_8
+
+## Инструкция по установке
+Для работы с программой необходимо установить Nano CAD 23 https://www.nanocad.ru/products/platform/
+Со страницы Releases скачать последнюю версию дистрибутива.
+Распаковать архив в любую папку.
+Запустить **Nano CAD**.
+С помощью команды **NETLOAD** загрузить файл **PSRNanoCadPlugIn.dll**
+После загрузки плагина становится доступна команда **BuildPlumbingSystem**, которая запускает процедуру автоматизированной трассировки трубопровода.
+
+## Инструкция по использованию
+В качестве исходных данных необходимо ввести контур стен, размещение стояка и потребителей.
+Все примитивы должны размещаться на определенных слоях и соответствовать следующим требованиям:
+- Стены обозначаются отрезками, размещенными на слое **Walls**. Отрезки должны составлять связный контур. При вводе отрезков должен быть включен шаг.
+- Потребители обозначаются окружностями на слое **Drains**. По осям X и Y центры окружностей должны лежать на отрезках стен. Координата по оси Z задает высоту вывода от пола. Диаметр окружности равен диаметру вывода потребителя.
+- Стояк обозначается одной окружностью на слое **VentStack**. Диаметр окружности равен диаметру вывода стояка. Если на слое стояка изображено несколько окружностей, то они будут проигнорированы.
+- Координаты по оси Z для отрезков стен и окружности игнорируются и принимаются равными 0.
+После ввода исходных данных нужно запустить команду **BuildPlumbingSystem**.
+Результаты выводятся в командной строке CAD-системы и включают перечень использованных материалов с указанием координат размещения фитингов.