Skip to content

Commit 0cec2d5

Browse files
committed
[#149] Update readme and previews.
1 parent deac137 commit 0cec2d5

13 files changed

Lines changed: 71 additions & 77 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This will allow you to automatically check your commit message and code before c
1919

2020
### First configure your workspace
2121

22-
Make sure you have Python 3.9 development tools. E.g., for Ubuntu, run `apt install python3.9-dev python3.9-venv`.
22+
Make sure you have Python 3.10 development tools. E.g., for Ubuntu, run `apt install python3.10-dev python3.10-venv`.
2323

2424
Activate virtual environment. E.g. for fish shell, run `source venv/bin/activate.fish`.
2525

‎README.md‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,11 @@
33
Do not edit it manually, edit the Moire source file instead.
44
-->
55

6-
The **Map Machine** project consists of
6+
**Map Machine** is a Python OpenStreetMap renderer that **can easily create static SVG maps** out of OpenStreetMap data. It also can generate PNG tiles for [slippy maps](https://wiki.openstreetmap.org/wiki/Slippy_Map) and run a tile server for them. It uses the Röntgen icon set ([site](https://enzet.ru/roentgen), [GitHub](https://github.com/enzet/Roentgen)) to display map features.
77

8-
* a Python [OpenStreetMap](https://openstreetmap.org) renderer:
9-
* SVG [map generation](#map-generation),
10-
* SVG and PNG [tile generation](#tile-generation),
11-
* the Röntgen ([site](https://enzet.ru/roentgen), [GitHub](https://github.com/enzet/Roentgen)) icon set: unique CC-BY 4.0 map icons.
8+
The idea behind the combination of the Röntgen icon set and the Map Machine project is to have a possibility to **show all the richness of the OpenStreetMap data**: to display any map feature represented by OpenStreetMap data tags by means of colors, shapes, and icons. For contributors it means possibility to display all changes even if they are small. And map users can dig down into the map and find every detail that was mapped.
129

13-
The idea behind the Map Machine 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. Map Machine is created both for map contributors: to display all changes one made on the map even if they are small, and for map users: to dig down into the map and find every detail that was mapped.
14-
15-
Unlike standard OpenStreetMap layers, **Map Machine is a playground for experiments** where one can easily try to support any unsupported tag, proposed tagging scheme, tags with little or even single usage, deprecated ones that are still in use.
10+
Unlike standard OpenStreetMap renderers, **Map Machine is a playground for experiments** where one can easily try to support any unsupported tag, proposed tagging scheme, tags with little or even single usage, deprecated ones that are still in use.
1611

1712
Map Machine is intended to be highly configurable, so it can generate precise but messy maps for OSM contributors as well as pretty and clean maps for OSM users. It can also use some slow algorithms for experimental features.
1813

@@ -22,31 +17,31 @@ See
2217
* [map features](#map-features),
2318
* [using Röntgen as JOSM style](#use-röntgen-as-josm-map-paint-style).
2419

25-
## Usage example
20+
## Get Started
2621

2722
```shell
2823
map-machine render -b 2.284,48.860,2.290,48.865
2924
```
3025

31-
will automatically download OSM data and render an SVG map of the specified area to `out/map.svg`. See [Map generation](#map-generation).
26+
will download OSM data and render an SVG map of the specified area to `out/map.svg`. See [Map generation](#map-generation).
3227

3328
```shell
3429
map-machine tile -b 2.361,48.871,2.368,48.875
3530
```
3631

37-
will automatically download OSM data and render PNG tiles that cover the specified area to the `out/tiles` directory. See [Tile generation](#tile-generation).
32+
will download OSM data and render PNG tiles that cover the specified area to the `out/tiles` directory. See [Tile generation](#tile-generation).
3833

39-
## Röntgen icon set
34+
## Röntgen Icon Set
4035

41-
The central feature of the project is the Röntgen icon set. It is a set of monochrome 14 × 14 px pixel-aligned icons specially created for the Map Machine project. Unlike the Map Machine source code, which is under the MIT license, all icons are under the [CC BY](https://creativecommons.org/licenses/by/4.0/) license. So, with the appropriate credit the icon set can be used outside the project. Some icons can be used as emoji symbols.
36+
The central feature of the project is the Röntgen icon set (see [site](https://enzet.ru/roentgen), [GitHub](https://github.com/enzet/Roentgen)). It is a set of monochrome 14 × 14 px pixel-aligned icons specially created for the Map Machine project. Unlike the Map Machine source code, which is under the MIT license, all icons are under the [CC BY](https://creativecommons.org/licenses/by/4.0/) license. So, with the appropriate credit the icon set can be used outside the project.
4237

43-
## Map features
38+
## Map Features
4439

45-
### Extra icons
40+
### Extra Icons
4641

4742
Map Machine uses icons to visualize tags for nodes and areas. But unlike other renderers, Map Machine can use more than one icon to visualize an entity and can use colors to visualize [`colour`](https://wiki.openstreetmap.org/wiki/Key:colour) value or other entity properties (like [`material`](https://wiki.openstreetmap.org/wiki/Key:material) or [`genus`](https://wiki.openstreetmap.org/wiki/Key:genus)).
4843

49-
### Isometric building shapes
44+
### Isometric Building Shapes (Experimental)
5045

5146
With `--buildings isometric` or `--buildings isometric-no-parts` (not set by default), buildings are drawn using isometric shapes for walls and shade in proportion to [`building:levels`](https://wiki.openstreetmap.org/wiki/Key:building:levels), [`building:min_level`](https://wiki.openstreetmap.org/wiki/Key:building:min_level), [`height`](https://wiki.openstreetmap.org/wiki/Key:height), and [`min_height`](https://wiki.openstreetmap.org/wiki/Key:min_height) values.
5247

@@ -58,7 +53,7 @@ map-machine render -c -26.19049,28.05605 -s 600,400 --buildings isometric
5853

5954
![3D buildings](doc/buildings.svg)
6055

61-
### Road lanes
56+
### Road Lanes (Experimental)
6257

6358
To determine the road width Map Machine uses the [`width`](https://wiki.openstreetmap.org/wiki/Key:width) tag value or estimates it based on the [`lanes`](https://wiki.openstreetmap.org/wiki/Key:lanes) value. If lane value is specified, it also draws lane separators. This map style is highly inspired by Christoph Hormann's post [Navigating the Maze](https://blog.imagico.de/navigating-the-maze-part-2/).
6459

@@ -72,10 +67,19 @@ map-machine render -c 47.61224,-122.33866 -s 600,400
7267

7368
### Trees
7469

75-
Visualization of tree leaf types (broadleaved or needle-leaved) and genus or taxon by means of icon shapes and leaf cycles (deciduous or evergreen) by means of color.
70+
Map Machine can visualize different aspects of trees:
71+
72+
* trunk diameter, circumference, and/or diameter_crown,
73+
* leaf types: broadleaved or needle-leaved,
74+
* leaf cycles: deciduous or evergreen,
75+
* genus or taxon (e.g. birch (*Betula*), palm (*Arecaceae*), maple (*Acer*).
7676

7777
#### Example
7878

79+
```shell
80+
map-machine render -c 55.751,37.628 -s 600,400
81+
```
82+
7983
![Trees](doc/trees.svg)
8084

8185
### Viewpoint and camera direction
@@ -94,7 +98,7 @@ map-machine render -c 52.50892,13.3244 -s 600,400 -z 18.5
9498

9599
### Power tower design
96100

97-
Visualize [`design`](https://wiki.openstreetmap.org/wiki/Key:design) values used with [`power`](https://wiki.openstreetmap.org/wiki/Key:power) = [`tower`](https://wiki.openstreetmap.org/wiki/Tag:power=tower) and [`power`](https://wiki.openstreetmap.org/wiki/Key:power) = [`pole`](https://wiki.openstreetmap.org/wiki/Tag:power=pole) tags. `design` has more than 1 million usages in OpenStreetMap.
101+
Map Machine can visualize a lot of [`design`](https://wiki.openstreetmap.org/wiki/Key:design) values used with [`power`](https://wiki.openstreetmap.org/wiki/Key:power) = [`tower`](https://wiki.openstreetmap.org/wiki/Tag:power=tower) and [`power`](https://wiki.openstreetmap.org/wiki/Key:power) = [`pole`](https://wiki.openstreetmap.org/wiki/Tag:power=pole) tags.
98102

99103
![Power tower design](doc/icons_power.svg)
100104

@@ -118,7 +122,7 @@ Japanese maps usually use [special symbols](https://en.wikipedia.org/wiki/List_o
118122

119123
### Indoor features
120124

121-
Draw indoor features specifying level with `--level` option. Possible values are numbers (e.g. `1`, `0.5`), lists of number separated by `;` (e.g. `1;2;4;4.5`), `all`, `overground`, and `underground`. The default value is not `all`, but `overground`, so underground objects are not shown on the map if `--level` option is not specified.
125+
Indoor features can be visualized by specifying level with `--level` option. Possible values are numbers (e.g. `1`, `0.5`), lists of number separated by `;` (e.g. `1;2;4;4.5`), `all`, `overground`, and `underground`. The default value is not `all`, but `overground`, so underground objects are not shown on the map if `--level` option is not specified.
122126

123127
#### Example
124128

@@ -331,6 +335,7 @@ Map configuration options used by `render` and `tile` commands:
331335
|---|---|
332336
| <span style="white-space: nowrap;">`--scheme`</span> `<id> or <path>` | scheme identifier (look for `<id>.yml` file) or path to a YAML scheme file, default value: `default` |
333337
| <span style="white-space: nowrap;">`--buildings`</span> `<mode>` | building drawing mode: no, flat, isometric, isometric-no-parts, default value: `flat` |
338+
| <span style="white-space: nowrap;">`--roads`</span> `<mode>` | road drawing mode: no, simple, lanes, default value: `simple` |
334339
| <span style="white-space: nowrap;">`--mode`</span> `<string>` | map drawing mode: normal, author, time, white, black, default value: `normal` |
335340
| <span style="white-space: nowrap;">`--overlap`</span> `<integer>` | size of the margin in pixels to leave around icons and text, default value: 12 |
336341
| <span style="white-space: nowrap;">`--labels`</span> `<string>` | label drawing mode: no, main, all, address, default value: `main` |

‎doc/INSTALL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## Install
77

8-
Map Machine requires [Python](https://www.python.org) 3.9, [pip](https://pip.pypa.io/en/stable/installation/), and two libraries:
8+
Map Machine requires [Python](https://www.python.org) 3.10, [pip](https://pip.pypa.io/en/stable/installation/), and two libraries:
99

1010
* [cairo 2D graphic library](https://www.cairographics.org/download/),
1111
* [GEOS library](https://libgeos.org).

‎doc/buildings.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎doc/colors.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎doc/indoor.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎doc/lanes.svg‎

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)