mirror of
https://github.com/enzet/map-machine.git
synced 2025-05-29 00:46:27 +02:00
Use generated options in documentation.
This commit is contained in:
parent
8ef527207f
commit
778b6dfb61
2 changed files with 15 additions and 14 deletions
19
README.md
19
README.md
|
@ -145,12 +145,19 @@ python roentgen.py render -b 2.284,48.86,2.29,48.865
|
||||||
|
|
||||||
### Arguments ###
|
### Arguments ###
|
||||||
|
|
||||||
* `--boundary-box` or `-b`: boundary box to draw. Value: `<longitude 1>,<latitude 1>,<longitude 2>,<latitude 2>`. If first value is negative, use quotation marks and space before first `-`. For example, `-b " -122.335,47.614,-122.325,47.617"`.
|
| Option | Description |
|
||||||
* `--scale` or `-s`: OSM [zoom level](https://wiki.openstreetmap.org/wiki/Zoom_levels). Default is 18.
|
|---|---|
|
||||||
* `-o`: path to output SVG file name. Default is `out/map.svg`.
|
| `-h`, `--help` | show this help message and exit |
|
||||||
* `-i`: path to input XML file name. If this argument is not set, XML file will be downloaded through OpenStreetMap API.
|
| `-i`, `--input` | input XML file name or names (if not specified, file will be downloaded using OpenStreetMap API) |
|
||||||
|
| `-o`, `--output` | output SVG file name, default value: \tt {out/map.svg} |
|
||||||
Check all arguments with `python roentgen.py render --help`.
|
| `-b`, `--boundary-box` | geo boundary box, use space before "-" if the first value is negative |
|
||||||
|
| `-s`, `--scale` | OSM zoom level (may not be integer), default value: \tt {18} |
|
||||||
|
| `--cache` | path for temporary OSM files, default value: \tt {cache} |
|
||||||
|
| `--labels` | label drawing mode: `no`, `main`, or `all`, default value: \tt {main} |
|
||||||
|
| `--overlap` | how many pixels should be left around icons and text, default value: \tt {12} |
|
||||||
|
| `--mode` | map drawing mode, default value: \tt {normal} |
|
||||||
|
| `--seed` | seed for random, default value: \tt {} |
|
||||||
|
| `--level` | display only this floor level, default value: \tt {None} |
|
||||||
|
|
||||||
Tile generation
|
Tile generation
|
||||||
---------------
|
---------------
|
||||||
|
|
|
@ -162,7 +162,7 @@ Every way and node displayed with the random color picked for each author with \
|
||||||
|
|
||||||
\2 {Installation} {installation}
|
\2 {Installation} {installation}
|
||||||
|
|
||||||
Requirements: Python (at least 3.8).
|
Requirements\: Python (at least 3.8).
|
||||||
|
|
||||||
To install all packages, run\:
|
To install all packages, run\:
|
||||||
|
|
||||||
|
@ -185,13 +185,7 @@ Example\:
|
||||||
|
|
||||||
\3 {Arguments} {arguments}
|
\3 {Arguments} {arguments}
|
||||||
|
|
||||||
\list
|
\options {render}
|
||||||
{\tt {--boundary-box} or \tt {-b}\: boundary box to draw. Value\: \tt {<longitude 1>,<latitude 1>,<longitude 2>,<latitude 2>}. If first value is negative, use quotation marks and space before first \tt {-}. For example, \tt {-b " -122.335,47.614,-122.325,47.617"}.}
|
|
||||||
{\tt {--scale} or \tt {-s}\: OSM \href {https://wiki.openstreetmap.org/wiki/Zoom_levels} {zoom level}. Default is 18.}
|
|
||||||
{\tt {-o}\: path to output SVG file name. Default is \tt {out/map.svg}.}
|
|
||||||
{\tt {-i}\: path to input XML file name. If this argument is not set, XML file will be downloaded through OpenStreetMap API.}
|
|
||||||
|
|
||||||
Check all arguments with \tt {python roentgen.py render --help}.
|
|
||||||
|
|
||||||
\2 {Tile generation} {tile-generation}
|
\2 {Tile generation} {tile-generation}
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue