Add readme for lownloader

sandermvanvliet · Dec 26, 2023 · 95e530f · 95e530f
1 parent bc3b200
commit 95e530f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/RoadCaptain.ZwiftRouteDownloader/README.md b/src/RoadCaptain.ZwiftRouteDownloader/README.md
@@ -0,0 +1,5 @@
+# RoadCaptain Zwift Route Downloader
+
+A utility that uses [zwift-data](https://github.com/andipaetzold/zwift-data/) do download the GPX data for Zwift routes in a particular world from Strava.
+
+The GPX files are ingested by [RoadCaptain.SegmentBuilder](../RoadCaptain.SegmentBuilder) and [RoadCaptain.MarkerBuilder](../RoadCaptain.MarkerBuilder) to generate the segments and markers (sprints / KOMs) used in RoadCaptain.