source: subversion/applications/rendering/osmarender/static-osmarender/README.txt @ 23318

Last change on this file since 23318 was 1560, checked in by nickburch, 13 years ago

Add a -h option, that prints out the readme

File size: 2.0 KB
Line 
1                 OSM static osmarender tile generator
2                 ------------------------------------
3
4Requires:
5 * xalan2 or xsltproc
6 * ImageMagick (for identify)
7 * inkscape
8 * vips <http://www.vips.ecs.soton.ac.uk/> - needs tools, not just library
9
10Will take a .osm file, pass it through osmarender at a number of different
11scale factors. It will then output these svgs at increasing DPI levels,
12and chop them up into tiles. Finally, the bundled display.html will be
13copied in, to allow browing of the tiles.
14
15If a copy of osmarender is found in the osmarender/ subdirectory, then that
16will be used for rendering. Otherwise, a fresh svn checkout will be made
17and used.
18
19The tiles will be output to a subdirectory, named based on the .osm file
20being rendered.
21
22
23Program Arguments:
24 -initial-dpi <dpi>
25      The DPI to output the initial map at. (Subsequent scales will be
26       done at higher DPIs than this).
27      Should be chosen to produce a map somewhere between 400x400 and 600x600
28 -osmarender-scales <scale,scale,scale>
29      The list of osmarender scales to generate the image at. Will generate
30       one set of tiles for each scale listed, each set of tiles at twice
31       the DPI of the last.
32      You need to list a scale for each zoom level you want, but they can
33       be the same
34
35      eg     -osmarender-scales 0.3,0.5,1.0,1.0
36 <filename.osm>
37      The .osm file to render
38
39
40Outstanding Issues:
41* For each tile we generate, we call vips. This can be a bit slow, so we
42   should really find a way to have vips spit out several tiles once it has
43   started processing the large image
44* You have to figure out the initial DPI yourself. Without the .osm file
45   including the bounding box, I'm not sure how we can calculate one for you
46* As you change the osmarender scale, not only does the page size change, but
47   the aspect ratio does too. So, your tiles will never be the same size or
48   shape.
49* The browsing interface is pretty basic, and could really use being made
50   a lot snazzier.
Note: See TracBrowser for help on using the repository browser.