From 0a42123b150e06f28ae82e460e854984c2dc9648 Mon Sep 17 00:00:00 2001
From: Yann Herklotz <ymherklotz@gmail.com>
Date: Sun, 7 Jan 2018 23:09:06 +0000
Subject: [Docs] Changing documentation

---
 docs/matrix.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 docs/matrix.md

(limited to 'docs/matrix.md')

diff --git a/docs/matrix.md b/docs/matrix.md
new file mode 100644
index 00000000..93138bb9
--- /dev/null
+++ b/docs/matrix.md
@@ -0,0 +1,29 @@
+Matrix Guide {#matrix_guide}
+============
+
+The matrix class is a templated class which implements a mathematical %Matrix.
+
+
+Usage Guide
+-----------
+
+The class can be instantiated
+
+
+Example Code
+------------
+
+Creating a %Matrix and performing operations on it.
+
+``` c++
+#include <YAGE/Math/matrix.hpp>
+
+int main(int, char **)
+{
+    yage::Matrix<2, 2, int> mat1 {{1, 2, 3, 4}};
+    yage::Matrix<2, 2, int> mat2 {{5, 6, 7, 8}};
+
+    int dot = yage::math::dot(mat1, mat2);
+    return 0;
+}
+```
-- 
cgit