[mkgmap-dev] proposed README organization

Mon Jul 20 15:03:06 BST 2009

As another new user, I would be happy to help out with the documentation 
as I've had to create a fair bit of my own recently just to get started.

Garvan & maew wrote:
> Greg Troxel wrote:
>> 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.
>>   
> As a new user I also think the documentation needs improvement, and look 
> froward to your contributions. For a utility like this, I agree that 
> having it in the source is most useful.
> 
> Garvan
> 
> _______________________________________________
> mkgmap-dev mailing list
> mkgmap-dev at lists.mkgmap.org.uk
> http://www.mkgmap.org.uk/mailman/listinfo/mkgmap-dev