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