aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5622524..cb776c1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
-# zig-raytracer
-Lightweight raytracer in Zig
+# Numerical Linear Algebra
+
+This repo contains a small C++ dense numerical linear algebra library for double, with a companion experiments directory for evaluating performance.
+
+## Build
+
+```bash
+cmake -S . -B build
+cmake --build build
+```
+
+## Run tests
+
+```bash
+ctest --test-dir build --output-on-failure
+```
+
+## Run the example
+
+```bash
+./build/solve_linear_system
+``` \ No newline at end of file