Skip to content

Commit

Permalink
update documentation for CLI usage in USAGE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
treee111 committed Apr 7, 2022
1 parent 5d8efcf commit 1e7f414
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -14,7 +18,7 @@ Set your arguments as required via the window:

<img src="https://github.com/treee111/wahooMapsCreator/blob/develop/docs/gui.png" alt="wahooMapsCreator GUI" width=35%>

### CLI (Command Line Interface)
## CLI (Command Line Interface)

From the `root` folder of wahooMapsCreator, run:
- `python wahoo_map_creator.py cli -co <country_name>`
Expand All @@ -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 <country>`

**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 <xy_coordinate,xy_coordinate>`

### 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`
- 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`

0 comments on commit 1e7f414

Please sign in to comment.