Updated readme
All checks were successful
Merge-Checker / build_and_test (pull_request) Successful in 1m10s

This commit is contained in:
2025-06-30 14:52:48 -04:00
parent 99c0d3ed70
commit 8e4595f2ef

View File

@@ -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
# 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`