Update readme for latest CLI args
This commit is contained in:
parent
0f6d71f1c0
commit
b5ed1f304b
31
README.md
31
README.md
|
@ -24,17 +24,30 @@ Program Usage
|
||||||
=
|
=
|
||||||
```
|
```
|
||||||
usage: process_maps.py [-h] [--map-list MAP_LIST] [--no-sleep] [--use-ram]
|
usage: process_maps.py [-h] [--map-list MAP_LIST] [--no-sleep] [--use-ram]
|
||||||
|
[--max-heap-space MAX_HEAP_SPACE]
|
||||||
|
[--output-map-name OUTPUT_MAP_NAME]
|
||||||
|
[--cached-maps-dir CACHED_MAPS_DIR]
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
--map-list MAP_LIST a text file with one map URL per line, can be specified
|
--map-list MAP_LIST a text file with one map URL per line, can be
|
||||||
more than once
|
specified more than once
|
||||||
--no-sleep don't sleep between downloads -- WARNING you can easily
|
--no-sleep don't sleep between downloads -- WARNING you can
|
||||||
run into throttling on mirrors if you use this option
|
easily run into throttling on mirrors if you use this
|
||||||
--use-ram use RAM for mapsforge processing -- WARNING mapsforge
|
option
|
||||||
uses 10x the map size in RAM for processing (ie. 100Mb
|
--use-ram use RAM for mapsforge processing -- WARNING mapsforge
|
||||||
map = 1Gb RAM usage), you want a LOT of RAM for this
|
uses 10x the map size in RAM for processing (ie. 100Mb
|
||||||
option
|
map = 1Gb RAM usage), you want a LOT of RAM for this
|
||||||
|
option
|
||||||
|
--max-heap-space MAX_HEAP_SPACE
|
||||||
|
set the max heap space for the JVM, use standard -Xmx
|
||||||
|
values, default (4g) should be fine if not using
|
||||||
|
--use-ram argument
|
||||||
|
--output-map-name OUTPUT_MAP_NAME
|
||||||
|
set the output .map and .poi file names
|
||||||
|
--cached-maps-dir CACHED_MAPS_DIR
|
||||||
|
Use cached maps in the specified directory instead of
|
||||||
|
downloads using map lists
|
||||||
```
|
```
|
||||||
|
|
||||||
Licencing
|
Licencing
|
||||||
|
|
Reference in a new issue