docs: Добавлен readme.md

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"

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
+...
+```