aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a06566
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# linmath.h -- A small library for linear math as required for computer graphics
+
+[![CircleCI](https://circleci.com/gh/datenwolf/linmath.h.svg?style=svg)](https://app.circleci.com/pipelines/github/datenwolf/linmath.h)
+
+
+linmath.h provides the most used types required for programming computer graphics:
+
+vec3 -- 3 element vector of floats
+vec4 -- 4 element vector of floats (4th component used for homogenous computations)
+mat4x4 -- 4 by 4 elements matrix, computations are done in column major order
+quat -- quaternion
+
+The types are deliberately named like the types in GLSL. In fact they are meant to
+be used for the client side computations and passing to same typed GLSL uniforms.
+