From c8f17169d95504e89634bb4e57668fdcc65e2d49 Mon Sep 17 00:00:00 2001
From: Roland Conybeare <rconybeare@gmail.com>
Date: Sat, 16 Mar 2024 13:04:46 -0400
Subject: [PATCH] xo-kalmanfilter: + README.md

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..fd4ef52d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# kalman filter library
+
+linear kalman filter implementation.
+
+## Getting Started
+
+### build + install dependencies
+
+build+install these first
+
+- xo-reactor [github.com/Rconybea/xo-reactor](https://github.com/Rconybea/xo-reactor)
+
+See `.github/workflows/main.yml` in this repo for example build+install on ubuntu
+
+### build + install xo-kalmanfilter
+```
+$ cd xo-kalmanfilter
+$ mkdir build
+$ cd build
+$ INSTALL_PREFIX=/usr/local  # or wherever you prefer
+$ cmake -DCMAKE_MODULE_PATH=${INSTALL_PREFIX}/share/cmake -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX} ..
+$ make
+$ make install
+```
+(also see .github/workflows/main.yml)
+
+### build for unit test coverage
+```
+$ cd xo-kalmanfilter
+$ mkdir ccov
+$ cd ccov
+$ cmake -DCMAKE_MODULE_PATH=${INSTALL_PREFIX}/share/cmake  -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX} -DCODE_COVERAGE=ON -DCMAKE_BUILD_TYPE=Debug ..
+```
+
+## Development
+
+### LSP support
+
+LSP looks for compile commands in the root of the source tree;
+cmake creates them in the root of its build directory.
+
+```
+$ cd xo-kalmanfilter
+$ ln -s build/compile_commands.json
+```
+
+### display cmake variables
+
+- `-L` list variables
+- `-A` include 'advanced' variables
+- `-H` include help text
+
+```
+$ cd xo-kalmanfilter/build
+$ cmake -LAH
+```