diff --git a/README.md b/README.md index d2cfa2d..1ec8fef 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,20 @@ A simple Kalman Filter implementation in Python +## Dependencies + +The python packages `numpy`, `matplotlib` and `geopy` are required: + +```bash +$ pip install numpy matplotlib geopy +``` + ## Usage From the root directory of this repository run ```bash -python -m kalman_filter +$ python -m kalman_filter ``` + +Which example is run can be changed in `kalman_filter/__main__.py`