##############################################
# ILCUTIL README
##############################################


Description:
------------------------------------------------------------------------------

    ILCUTIL is a utility package for the iLCSoft software framework.

    It is intended to be a "meta-package" which packages together a set of
    independent utility packages living in separate sub-directories.

    It should be possible to configure, build and use all of the sub-packages
    independently of ILCUTIL.

    Currently ILCUTIL contains the following sub-packages:

        - ILCSOFT_CMAKE_MODULES (Previously known as CMakeModules)
            This package contains a set of cmake modules and utility macros.
            Almost all iLCSoft packages depend on this sub-package for the
            cmake configure/build step.

            There are 3 possible ways of using the ILCSOFT_CMAKE_MODULES:


            1. (Preferred ) Using the ILCUTIL package, i.e.:

                FIND_PACKAGE( ILCUTIL COMPONENTS ILCSOFT_CMAKE_MODULES )

                ILCUTIL_DIR or CMAKE_PREFIX_PATH needs to be set to find
                the configuration file ILCUTILConfig.cmake.


                FIND_PACKAGE( ILCUTIL COMPONENTS ILCSOFT_CMAKE_MODULES streamlog )



            2. Directly using the ILCSOFT_CMAKE_MODULES package, e.g.:

                FIND_PACKAGE( ILCSOFT_CMAKE_MODULES )

                ILCSOFT_CMAKE_MODULES_DIR or CMAKE_PREFIX_PATH need to be
                set in order to find ILCSOFT_CMAKE_MODULESConfig.cmake.

                This method should be used in packages living inside ILCUTIL,
                e.g. ILCTEST



            3. By setting CMAKE_MODULE_PATH directly to where the cmake
                modules and macros live.

                This method should be used with care or for debugging purposes.




        - ILCTEST
            This package provides utilities to help developers write new C++
            tests in their packages. It consists of a C++ utility header and
            a set of cmake macros (living inside ILCSOFT_CMAKE_MODULES) to
            facilitate adding new tests in a straight-forward manner.



        - streamlog
            This package provides a set of logging classes for C++ applications.



        - example
            This example shows how to create a new package in ILCUTIL which
            depends on other sub-packages from ILCUTIL



Build instructions:
------------------------------------------------------------------------------

    To build ILCTUTIL you need at least cmake version 2.8.2.

    Once cmake is in your PATH, just follow this steps:

    mkdir build
    cd build
    cmake ..
    make install




Support:
------------------------------------------------------------------------------

For questions or support please visit the forum:
http://forum.linearcollider.org/