diff --git a/README.md b/README.md index 213e570..1c2e4cd 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ **Röntgen** (or **Roentgen** when ASCII is preferred) project consists of - * simple Python [OpenStreetMap](http://openstreetmap.org) renderer (see [usage](#usage), [renderer documentation](#map-generation)), + * simple Python [OpenStreetMap](http://openstreetmap.org) renderer and tile generator (see [usage](#usage-example), [renderer documentation](#map-generation), [tile generation](#tile-generation)), * [set of CC-BY 4.0 icons](#icon-set) that can be used outside the project. The idea behind the Röntgen project is to **show all the richness of the OpenStreetMap data**: to have a possibility to *display any map feature* represented by OpenStreetMap data tags by means of colors, shapes, and icons. Röntgen is created for OpenStreetMap contributors: to display all changes one made on the map even if they are small, and for users: to dig down into the map and find every detail that was mapped. @@ -152,13 +152,8 @@ will download OSM data to `cache/2.284,48.860,2.290,48.865.osm` and write output | `-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: `out/map.svg` | | `-b`, `--boundary-box` `,,,` | geo boundary box; if first value is negative, enclose the value with quotes and use space before `-` | -| `-s`, `--scale` `` | OSM zoom level (may not be integer), default value: 18 | | `--cache` `` | path for temporary OSM files, default value: `cache` | -| `--labels` | label drawing mode: `no`, `main`, or `all`, default value: `main` | -| `--overlap` | how many pixels should be left around icons and text, default value: 12 | -| `--mode` | map drawing mode, default value: `normal` | -| `--seed` | seed for random | -| `--level` | display only this floor level | +| `--seed` `` | seed for random | Tile generation --------------- @@ -168,7 +163,6 @@ Command `tile` is used to generate PNG tiles for [slippy maps](https://wiki.open | Option | Description | |---|---| | `-c`, `--coordinates` `,` | coordinates of any location inside the tile | -| `-s`, `--scale` `` | OSM zoom level, default value: 18 | | `-t`, `--tile` `//` | tile specification | | `--cache` `` | path for temporary OSM files, default value: `cache` | | `-b`, `--boundary-box` `,,,` | construct the minimum amount of tiles that cover requested boundary box | @@ -253,3 +247,12 @@ To create MapCSS with Röntgen style also for ways and relations, run `roentgen To enable / disable Röntgen map paint style go to ViewMap Paint StylesRöntgen. +#### Example #### + +![JOSM example](doc/josm.png) + +Example of using Röntgen icons on top of Mapnik style. Map Paint Styles: + + * ✓ Mapnik + * ✓ Röntgen + diff --git a/doc/josm.png b/doc/josm.png new file mode 100644 index 0000000..a223688 Binary files /dev/null and b/doc/josm.png differ diff --git a/doc/readme.moi b/doc/readme.moi index 26f9878..304db60 100644 --- a/doc/readme.moi +++ b/doc/readme.moi @@ -258,3 +258,12 @@ To create MapCSS with Röntgen style also for ways and relations, run \m {roentg {URL / File: set path to \m {out/roentgen_mapcss/roentgen.mapcss}.} To enable / disable Röntgen map paint style go to \kbd {View} → \kbd {Map Paint Styles} → \kbd {Röntgen}. + +\4 {Example} + +\image {doc/josm.png} {JOSM example} + +Example of using Röntgen icons on top of Mapnik style. Map Paint Styles\: +\list + {✓ Mapnik} + {✓ Röntgen}