From 1e7f414907efb298c9d9309ca59c6082f02a68d6 Mon Sep 17 00:00:00 2001 From: Benjamin Kreuscher Date: Thu, 7 Apr 2022 15:32:58 +0200 Subject: [PATCH] update documentation for CLI usage in USAGE.md --- docs/USAGE.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs/USAGE.md b/docs/USAGE.md index 1fedc27f..bce40e52 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -5,7 +5,11 @@ wahooMapsCreator can be used in two different ways: Both ways support the same arguments to be used for the map-creation process. You can choose the arguments via GUI or as [CLI-arguments](#advanced-cli-usage). -### GUI (Graphical User Interface) +## Run wahooMapsCreator for your country +It might be a good idea to run wahooMapsCreator first for a small country e.g. Malta to check if everything is running fine. +In a next step you can run it for your own country. + +## GUI (Graphical User Interface) From the `root` folder of wahooMapsCreator, run: - `python wahoo_map_creator.py gui` @@ -14,7 +18,7 @@ Set your arguments as required via the window: wahooMapsCreator GUI -### CLI (Command Line Interface) +## CLI (Command Line Interface) From the `root` folder of wahooMapsCreator, run: - `python wahoo_map_creator.py cli -co ` @@ -23,19 +27,28 @@ Examples: - for Malta: `python wahoo_map_creator.py cli -co malta` - for Ireland: `python wahoo_map_creator.py cli -co ireland` -### Run wahooMapsCreator for your country -It might be a good idea to run wahooMapsCreator first for a small country e.g. Malta to check if everything is running fine. -In a next step you can run it for your own country. - -### Advanced CLI-Usage +## Advanced CLI-Usage The script supports many arguments via command line. For a list of all supported arguments, run: - `python wahoo_map_creator.py cli -h` -Examples: +### Main arguments +**Create maps for a country** +- `python wahoo_map_creator.py cli -co ` + +**Create maps for X/Y coordinates** + +In particular for testing adjustments in configuration-files or coding it is helpful to create maps for only one tile or a handful of tiles! + +To create maps for only one tile and not a whole country, one can use the X/Y coordinates of that tile. X/Y coordinates can be retrieved from this in zoom-level 8: [link](http://tools.geofabrik.de/map/#8/50.3079/8.8026&type=Geofabrik_Standard&grid=1). +- `python wahoo_map_creator.py cli -xy ` + +### Examples - for Malta, download new maps if existing maps are older than 100 days and process files even if files exist - `python wahoo_map_creator.py cli -co malta -md 100 -fp` - for Germany, download and process whole tiles which involves other countries than the given - `python wahoo_map_creator.py cli -co germany -bc` -- to create maps for only one tile and not a whole country, one can use the X/Y coordinates of that tile. X/Y coordinates can be retrieved from this [link]([#advanced-cli-usage](http://tools.geofabrik.de/map/#8/50.3079/8.8026&type=Geofabrik_Standard&grid=1)) in zoom-level 8. - - `python wahoo_map_creator.py cli -xy 134/88` \ No newline at end of file +- to create maps for only one tile + - `python wahoo_map_creator.py cli -xy 134/88` +- for multiple tiles + - `python wahoo_map_creator.py cli -xy 134/88,133/88` \ No newline at end of file