.. Cmake Support for KUSP Software documentation master file, created by
   sphinx-quickstart on Wed Jul  1 00:08:34 2009.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to CMake Support for KUSP Software's documentation!
===========================================================

**Installation Guide**

.. toctree::
   :maxdepth: 2

    installation
    development
    simple_cmake_example
    intermediate_cmake_example
    advanced_cmake_example
    cmake_quick_documentation_reference


KUSP Quick Install
------------------

The KUSP Quick Installation guide is meant for those familiar with *CMake*,
*Subversion*, the KUSP source tree, and general Linux software installation
methods. For a more detailed guide to KUSP installation, as well as information
on adding new software to the KUSP source tree, refer to the
:ref:`installation-guide-section` and :ref:`developers-guide-section`.

These instructions assume:
***************************

1) You are in the same directory as this file (INSTALL.txt)
2) You have set the following environmental variables in your bashrc
   by adding the lines::

       export KUSPROOT=<path-to-kusp-source>
       export KUSPINSTALL=<path-to-desired-install-directory>
       export KERNELROOT=<path-to-kusp-kernel-source>


STEPS
*******

#. **Get the Source**::

	$ svn co https://subversion.ittc.ku.edu/svn/libertos/kusp/trunk kusp


#. **Create a "build" directory to work in**::

   $ mkdir build	    
   $ cd build

#. **Run cmake <path to source**::

   $ cmake .. -DCMAKE_INSTALL_PREFIX=$KUSPROOT -DKERNELROOT=$KERNELROOT
   $ make
   $ make install

#. **Now Set the following environmental variables in your bashrc**::

   	 export PATH=$PATH:$KUSPINSTALL/bin
   	 export LD_LIBRARY_PATH=LD_LIBRARY_PATH:$KUSPINSTALL/lib
   	 export C_INCLUDE_PATH=$KUSPINSTALL/include
   	 export CPLUS_INCLUDE_PATH=$KUSPINSTALL/include
   	 export PYTHONPATH=$PYTHONPATH:$KUSPINSTALL/lib/python<your-version-number>/site-packages


#. **Reload your bashrc**::

   $ . ~/.bashrc


Alternate Source Install 
----------------------------------

If you have the KUSPINSTALL and KERNELROOT environmental variables
defined. You will still need to complete steps (4) and (5).


You can replace steps (2) and (4) from above with::

    $ make -f kusp.mk