universe@103: 
universe@151: -------------------------------------------------------------------------------
universe@151:                      UAP Common eXtensions - UCX
universe@151: -------------------------------------------------------------------------------
universe@103: 
universe@151: 0. Table of Contents:
universe@103: 
universe@151:   1. Introduction  ........................................................ 14
universe@151:   2. Build and Installation  .............................................. 24
universe@151:   3. Documentation  ....................................................... 57
universe@151:   4. Contact  ............................................................. 65
universe@103: 
universe@103: 
universe@151: 1. Introduction
universe@103: 
universe@151: UAP Common eXtensions provide useful data structures and algorithms for common
universe@151: programmatic tasks in C language. By design the features are divided into
universe@151: modules to minimize the library footprint. Using the build files you can create
universe@151: a static lib containing all modules, but you might also want use the UCX sources
universe@151: in your project and compile against specific modules to further minimize the
universe@151: footprint. Feel free to do so.
universe@151: 
universe@151: 
universe@151: 2. Build and Installation
universe@151: 
universe@151: Untar the source archive and run
universe@151: 
universe@151:   make CONF=<yourconfig>
universe@151: 
universe@151: If you are using gcc, then simply run
universe@151: 
universe@151:   make
universe@151: 
universe@151: The further available configurations are gcc-debug, g++, g++-debug, osx,
universe@151: osx-debug, suncc, suncc-debug and windows. The later uses microsoft visual C++
universe@151: compiler. If you want to use mingw oder cygwin, you can use the default gcc
universe@151: configuration.
universe@151: 
universe@151: The build files are placed into a build subdirectory, which is created if it
universe@151: does not exists.
universe@151: 
universe@151: To install UCX, run
universe@151: 
universe@151:   make install
universe@151: 
universe@151: or
universe@151: 
universe@151:   make install PREFIX=<install_dir>
universe@151: 
universe@151: The default prefix is /usr/local.
universe@151: 
universe@151: If you want to test you build, run
universe@151: 
universe@151:   make run CONF=<yourconfig>
universe@151: 
universe@151: 
universe@151: 3. Documentation
universe@151: 
universe@151: The code uses doxygen source code documentation. A html version of the
universe@151: documentation is also available here:
universe@151: 
universe@151:   http://develop.uap-core.de/ucx/1.0/index.html
universe@151: 
universe@151: 
universe@151: 4. Contact
universe@151: 
universe@151: Copyright (c) 2013 Olaf Wintermann
universe@151: 
universe@151:   Mike "UniversE" Becker        (universe@uap-core.de)
universe@151:   Olaf "Prometheus" Wintermann  (prometheus@uap-core.de)