diff --git a/README.md b/README.md index 11e54e4f..aa10f32f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,18 @@ # mpwo -Self hosted workout/activity tracker written in python +Self hosted workout/activity tracker written in Python. ![dashboard](docs/img/snapshot.png) + +Based on : +- [Flask](http://flask.pocoo.org) +- [Leaflet.js](http://leafletjs.com/) and [leaflet-gpx](https://github.com/mpetazzoni/leaflet-gpx) plugin +- [Bootstrap](https://startbootstrap.com/) and [SB Admin v2](https://startbootstrap.com/template-overviews/sb-admin-2/) theme -!! work in progress !! +## Prerequisites +- Python 3 (tested with 3.6 (on Manjaro)) +- Flask +- [PyYAML](http://pyyaml.org) +- [gpxpy](https://github.com/tkrajina/gpxpy) -- GPX file parser + +_!! work in progress !!_ \ No newline at end of file