These aren't wicked important, but I found them in my tree and I think they're more helpful than not: Index: doc/README.invoking =================================================================== --- doc/README.invoking (revision 1366) +++ doc/README.invoking (working copy) @@ -1,7 +1,35 @@ $Id$ +BASIC INVOCATION + README.invoking for mkgmap -[TODO: This file should either get the relevant parts of README, and -then be spiffed up, or point to resources/help/en/options.] +To run mkgmap, the basic invocation is + java -jar mkgmap.jar + +or + + java -jar /path/to/jar/mkgmap.jar + +JAVA OPTIONS + +There are two java-level options that are often given: + +-enableassertions + In Java assertions are disabled by default It is generally + recommended that assertions be enabled when running mkgmap. + +-Xmx2048m + The default java heap size is small. This makes the heap 2G, + which is a reasonable value on machines with 3G or more of + RAM. See README.sizes for discussion of how much heap is needed. + +BUILTIN HELP + +Run + + java -jar mkgmap.jar --help=options + +to get a list of options to mkgmap. This same list is available in +../resources/help/en/options. Index: doc/README.java =================================================================== --- doc/README.java (revision 1366) +++ doc/README.java (working copy) @@ -6,6 +6,16 @@ Version 1.6, or later, of java is required to run mkgmap. +** Mac hints + +Mac OS X 10.5 comes with Java 1.5. You can install 1.6 from + http://www.apple.com/downloads/macosx/apple/application_updates/javaformacos... + +After installing, set 1.6 as the default using JAVA preferences, which +will cause 'java -jar foo.jar' to use the 1.6 JRE. To cause ant to +use 1.6 to compile, set + export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/1.6/home + * building To build, you must have a JDK and apache ant installed. @@ -14,4 +24,4 @@ * running To run, you must have a JRE installed. See README.invoking and -README.examples. +README.examples. You can use a downloaded jar or one that you built.