From 8e4595f2ef0012722b89159a78364b4a757b4489 Mon Sep 17 00:00:00 2001 From: Cynopolis Date: Mon, 30 Jun 2025 14:52:48 -0400 Subject: [PATCH] Updated readme --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 925b2a5..bcc015f 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,11 @@ This matrix math library is focused on embedded development and avoids any heap memory allocation unless you explicitly ask for it. It uses templates to pre-allocate matrices on the stack. -There are still several operations that are works in progress such as: -- Add a function to calculate eigenvalues/vectors -- Add a function to compute RREF -- Add a function for SVD decomposition -- Add a function for LQ decomposition \ No newline at end of file +# Building +1. Initialize the repositiory with the command: +```bash +cmake -S . -B build -G Ninja +``` + +2. Go into the build folder and run `ninja` +3. That's it. You can test out the build by running `./unit-tests/matrix-tests` \ No newline at end of file