Requirements
============

Required tools and libraries:

    CMake 2.4 (http://www.cmake.org/)

        Cross platform build environment required to build the WebIssues Client.

    Qt 4.2 or newer (http://www.trolltech.com/products/qt/)

        GUI toolkit required to compile and run the WebIssues Client. On Windows, install
        the Qt/Windows Open Source Edition with the MinGW compiler. On Linux, install
        the appropriate devel package if you install Qt from binary packages.

Optional tools:

    Doxygen 1.5 (http://www.doxygen.org/)

        Tool needed to generate API documentation from the source code.


Compilation
===========

1) To configure the package, go to the directory where you have unpacked it and type:

      cmake .

   You can pass some additional parameters to this command:

      -G generator

         Type of files to generate. On Windows the generator must be set to "MinGW Makefiles".

      -D CMAKE_INSTALL_PREFIX=dir

         The prefix where the package will be installed. Defaults to /usr/local on Linux and
         C:\Program Files\WebIssues on Windows.

      -D CMAKE_BUILD_TYPE=type

         You can select the Debug build type to enable debugging support. The default type is
         the optimized Release build.

      -D QT_QMAKE_EXECUTABLE=path

         Path to the qmake executable. Use this option if the Qt toolkit cannot be found.

   If you want to build the package out of source, create a subdirectory, enter it and replace
   '.' with '..', for example:

      md build
      cd build
      cmake ..

   You can also use the CMakeSetup tool on Windows or ccmake on Linux to configure
   the build using a graphical environment. See the CMake documentation for more information
   about using these tools.

2) When the package is successfully configured, you can build it by running:

      make

3) To install the package, run:

      make install

   Depending on the installation prefix, you may need super user privileges to run this
   command.

4) If you have Doxygen, you can use the following command to build the API documentation:

      make apidox
