From 7b1f1372e3993860bd0909e6851952fffc5d097f Mon Sep 17 00:00:00 2001
From: Jon Santmyer <jon@jonsantmyer.com>
Date: Sun, 20 Nov 2022 23:35:33 -0500
Subject: initial commit. math using arbitrary length vectors

---
 README.MD | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.MD

(limited to 'README.MD')

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..b07b77d
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,17 @@
+# MATHVECTOR
+A simple C++ library for arbitrary length mathematical vectors. All functions
+and member classes lie in the mvec namespace
+
+## Use
+Add mvector.hpp to your project, make a new vector using
+```
+mvec::vec<double, 2>
+```
+or
+```
+mvec;:vec2<double>
+```
+mvec comes with multiple pre-built vector types. for vectors of length 2-4.
+
+Each pre-made vectors include x,y,z,w members that can access their respective
+indices in the vector
-- 
cgit v1.2.1