Added notes that were used to create the tool

README.md

@@ -1 +1,28 @@
+Overview
+=
 This project contains useful info/tools for processing OSM maps into the mapwriter file format (.map)
+
+Manual Procedure
+=
+
+Prep 
+== 
+- Download updated maps: http://download.geofabrik.de/north-america.html and http://download.geofabrik.de/north-america/canada.html  
+- Pull latest osmosis from http://wiki.openstreetmap.org/wiki/Osmosis 
+- Pull latest mapsforge for osmosis from https://github.com/mapsforge/mapsforge/blob/master/docs/Downloads.md 
+ 
+Process maps for device 
+== 
+- Setup osmosis in a directory (unzip release -- ZIPBOMB ALERT!!!!) 
+- Create plugins directory under osmosis 
+- Move mapsforge release jar to osmosis/lib/default/ 
+- Decompress maps (if they were previously compressed) 
+- ./osmosis bin/osmosis --rb file=../maps/a_map.osm.pbf --mapfile-writer file=../maps/a_map.map 
+-* If you run out of heap space add JAVACMD_OPTIONS="-Xmx16g" to the start of the line 
+-* If increasing the heap doesn't work, append type=hd to end of command 
+-* You can merge maps using --merge passed to osmosis (before --mapfile-writer) using n-1 instances of --merge where n is the number of --rb or --rx options passed 
+ 
+General Notes 
+= 
+Used to generate above info 
+* https://github.com/mapsforge/mapsforge/blob/master/docs/Getting-Started-Map-Writer.md