aboutsummaryrefslogtreecommitdiff
path: root/components/euler_angle/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'components/euler_angle/README.md')
-rw-r--r--components/euler_angle/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/components/euler_angle/README.md b/components/euler_angle/README.md
new file mode 100644
index 0000000..785114a
--- /dev/null
+++ b/components/euler_angle/README.md
@@ -0,0 +1,11 @@
+# Euler Angle Component for Serpentity
+
+This is a component for [serpentity][serpentity], it holds the following values:
+
+```
+-pitch <Number> // the rotation on the x axis
+-yaw <Number> // the rotation on the y axis
+-roll <Number> // the rotation on the z axis
+```
+
+[serpentity]: https://git.sr.ht/~rbdr/serpentity-lib