From c10873e19f2aebbd20374bceeb6f72ff924b97f2 Mon Sep 17 00:00:00 2001
From: Pavel Naboka <35613006+Zanzibarra@users.noreply.github.com>
Date: Fri, 8 Sep 2023 18:20:44 +0300
Subject: [PATCH] =?UTF-8?q?docs:=20=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB?=
 =?UTF-8?q?=D0=B5=D0=BD=20readme.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 pyproject.toml |  3 ++-
 readme.md      | 23 +++++++++++++++++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 readme.md

diff --git a/pyproject.toml b/pyproject.toml
index 4c16523..8a5b987 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,8 +1,9 @@
 [tool.poetry]
-name = "reinmetal"
+name = "PathPointsTransformer"
 version = "0.1.0"
 description = ""
 authors = ["Pavel Naboka <naboka@diakont.com>"]
+readme = ["readme.md"]
 
 [tool.poetry.dependencies]
 python = "^3.10"
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..2687488
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,23 @@
+# Преобразователь пути
+
+Скрипт преобразует путь, записанный в виде набора точек в файл `.\actual_points.txt`, 
+в путь с минимальным среднеквадратичным отклонением от пути, 
+записанного в виде набора точек в файл `.\expected_points.txt`.
+
+На данный момент результатом работы скрипта является 
+вывод в консоль массива углов поворота вокруг оси X, оси Y и оси Z и 
+последующего смещения вдоль оси X, оси Y и оси Z, 
+а также отрисовка 3D графика преобразованного пути и ожидаемого пути.
+
+Запускается скрипт командой `python main.py`
+
+***
+
+## Формат входных файлов
+Ожидаемые входные файлы `.\actual_points.txt` и `.\expected_points.txt` содержат в себе пути, записанные в формате:
+```text
+Xa Ya Za
+Xb Yb Zb
+Xc Yc Zc
+...
+```