logo separator

[mkgmap-dev] Documentation

From Steve Ratcliffe steve at parabola.me.uk on Sat Jan 12 22:57:51 GMT 2013

Hi

The project needs a good set of documentation maintained along with the
code that can be delivered as part of the distribution.

We do have a reasonable amount of documentation with the built in help
for all options, on the osm wiki and in the doc directory in the source.

However it is scattered and there is no really clear place for
a newcomer to start.

So I think we need a tutorial document that takes you from "first map"
and then gradually enhances it until you are in a position to build
and distribute a complete map set.

I have started on a separate document that will completely document
the style system and language. The current drafts can be seen in
pdf format here:

	http://www.mkgmap.org.uk/doc/pdf/style-manual.pdf

So that shows the idea.

I'll start on the tutorial, but I'm probably not the best person to
write most of it, especially anything Windows related. So I will
be looking for help with it.

I would also like to collect some how-to type documents as well.

I'm also going to start removing any out of date information in the
mkgmap/doc directory too.

..Steve


More information about the mkgmap-dev mailing list