From 4c4ab5cf482462a5aa7e1736ea3fa0a09dbbc2f1 Mon Sep 17 00:00:00 2001
From: "an.tsouchlos" <an.tsouchlos@gmail.com>
Date: Fri, 8 Apr 2022 01:21:15 +0000
Subject: [PATCH] Created README

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index e69de29..a756710 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,13 @@
+# Kalman Filter
+
+In this project, a simple linear Kalman Filter is implemented.
+
+## Usage
+
+From the root directory of this repository run
+
+```bash
+python -m kalman_filter
+```
+
+All parameters influencing the Kalman Filter and simulation can be modified in `kalman_filter/__main__.py`
\ No newline at end of file