======= I AM IN A HURRY, PLEASE GIVE ME SHORT INSTRUCTIONS ==================

Be sure to have Qt >= 4.2, libproj4 and libusb (not on Mac OS X) installed.

If you want to build on Windows, read INSTALL.Win32.html.

If you want to build a tar distribution, say
	./configure
	make
	make install   # not on Mac OS X
to build and install qlandkarte in /usr.

If you want to build a svn check-out, say
	./bootstrap.sh
	make
	make install   # not on Mac OS X
to build and install qlandkarte in /usr.

If any error occurs above, you have to read the rest of this file, sorry. ;-)
=============================================================================


I. Howto install QLandkarte

I.0 Prerequisites

For building QLandkarte, you need
 - Qt 4.2 or later
 - libproj4, available from <http://members.verizon.net/~vze2hc4d/proj4/>
 - libusb, available from <http://libusb.sourceforge.net/> (*not* needed on
   Windows and MacOS X!).
Note that on Windows and MacOS X the "native" usb support of the system will
be used. You should check your packaging system (deb or rpm) if it already
includes pre-built versions of these packages. You must install the
"development" packages for these libraries.
 
I.1 Build and install
 
QLandkarte uses QT's qmake system. In order to detect the "special" features
of your system, a "configure" script is included. You can pass the following
parameters to this script:

 --with-qt-dir=<path>
      If Qt is installed in a non-standard path, you can define the location
      here.
 --prefix=<path>, --bindir=<path>, --libdir=<path>
      To define an installation prefix, or explicitly define where the binary
      and the plugins shall be installed (default value: prefix=/usr).
 --with-extra-includes=<path>, --with-extra-libs=<path>
      If you installed libproj4 and/or libusb in a non-standard folder you
      can pass here extra folders where the compiler and linker should look
      for headers and libraries, respectively.
 --enable-release
      add this option to build an optimised version of QLandkarte without debug
      information.  The default is to build a version with debugging enabled,
      which will produce a much larger binary.
      
Type `configure --help' for more information.

To build and install, execute in your shell:

    ./configure
    make
    make install

Notes: If you want to build a bleeding-edge version from svn, instead of
       "./configure" run "./bootstrap.sh" to create and then run the configure
       script. To this end, make sure that autoconf is installed.

       You have to be root if you want to install QLandkarte in system folders.

       On MacOS X, you can skip the last step. The build process created a
       bundle in the "bin" subfolder of the top-level source folder which you
       can just double-click in the Finder or move to any appropriate location.


II. Howto install maps

Numerous maps for Garmin GPS receivers using the  IMG format can be found
on the world wide web using your favourite search engine. A map must contain:

* at least one *.tdb file
* one *.img file per *.tdb as basemap
* several *.img files as detailed map tiles.

Whereas map tiles have exclusively digits as filename, basemaps can have any
character in their name. If there are only files with digits, the basemap will
be the one with the lowest number, most likely.

If you use your maps with Garmin's MapSource, simply mount the windows partition
into your Linux file system. QLandkarte does only read data, thus the NFS
filesystem should be fine, too.

Use "File->Import Map..." to add a map to QLandkarte. It will ask you for the
map's directory first. Then you have to select the basemap. If there are several
*.tdb files you will be asked for a basemap for each of those *.tdb files.

Now you should see your map listed in the lefthand tabview "Maps".


III. Howto uninstall QLandkarte

Simply execute the uninstall command from the project's source root.

    make uninstall

If this failes, or you do not have the source tree, you can look for these files:

    /usr/bin/QLandkarte</li>
    ~/.config/QLandkarte/QLandkarte.conf
    /usr/lib/qlandkarte/*.so

The path '/usr/lib/qlandkarte/' might be different, depending on your distribution's policy.


