summaryrefslogtreecommitdiffstats
path: root/README.MD
diff options
context:
space:
mode:
Diffstat (limited to 'README.MD')
-rw-r--r--README.MD17
1 files changed, 17 insertions, 0 deletions
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