I've been trying to use mkgmap and having a bit of a hard time. I'm a little compulsive about having all the lore be in the source tree, and it seems the README is a bit behind the code. I have a bit of time here and there but not enough to really dig into the code. So I'll be trying to send patches to improve the state of the in-tree documenation after receiving some off-list encouragement to do so. Here's a patch which adds a README.INDEX that describes multiple readme files. If people think this is sane, I will start adjusting the docs to follow this plan and fill in some of the missing pieces, asking for help about the content on the list. I have saved a number of list postings that should be of great help - I am assuming that people do not mind their emails being cut/pasted/edited into READMEs.
Besides what I listed below, I think we need a README that explains to a newbie: if you want to make an img from osm data to use, what options should you use and why. Plus probably ones that explain how to get maps into MapSource and RoadTrip. Comments welcome. Index: README.INDEX =================================================================== --- README.INDEX (revision 0) +++ README.INDEX (revision 0) @@ -0,0 +1,49 @@ +$Id$ + +README.INDEX for mkgmap + +This file describes the various README files for mkgmap. Each file is +named README.name (where name is lower case) and covers a different +area of mkgmap usage. + +The intent is that everything known about mkgmap will be contained in +the various README files. Currently, README.INDEX describes a +proposed organization. Files are listed in an order intended to be +helpful to new users. + +* README.overview + +This file describes the purpose of the program and contains +acknowledgements. + +* README.invoking + +This file describes every command-line option for mkgmap. It assumes +that a .jar already exists and that there are no java issues. + +* README.splitter + +This file describes how to use the splitter with mkgmap. + +* README.styles + +This file describes how the style files work. + +* README.sizes + +This file contains information about how much memory is needed to +perform various operations. + +* README.img + +This files contains pointers to descriptions of the garmin formats. +It contains links to other related programs and documents. + +* README.java + +This file describes how to deal with java, CLASSPATH, which versions +work, etc. + +* README.building + +This file describes how to build mkgmap from source, producing a .jar. Property changes on: README.INDEX ___________________________________________________________________ Added: svn:keywords + Id
pgpWvqKUZA8ID.pgp
Description: PGP signature
_______________________________________________ mkgmap-dev mailing list mkgmap-dev@lists.mkgmap.org.uk http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev
