Merge pull request 'Updating the readme' (#7) from update-readme into main

Reviewed-on: #7

.gitea/workflows/Merge-Checker.yaml

@@ -41,7 +41,7 @@ jobs:
           mkdir -p unit-tests/timing-results
           if [ -x build/unit-tests/matrix-timing-tests ]; then
             echo "Running matrix-timing-tests with timing"
-            ./build/unit-tests/matrix-timing-tests -d yes &> unit-tests/timing-results/matrix-timing-tests.txt
+            /usr/bin/time -v build/unit-tests/matrix-timing-tests -d yes &> unit-tests/timing-results/matrix-timing-tests.txt
             cat unit-tests/timing-results/matrix-timing-tests.txt
           else
             echo "matrix-timing-tests executable not found or not executable"

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:
+# Building
-- Add a function to calculate eigenvalues/vectors
+1. Initialize the repositiory with the command:
-- Add a function to compute RREF
+```bash
-- Add a function for SVD decomposition
+cmake -S . -B build -G Ninja
-- Add a function for LQ decomposition
+```
+
+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`