README


-------------------------------------------------------------------------------
                     UAP Common eXtensions - UCX
-------------------------------------------------------------------------------

0. Table of Contents:

  1. Introduction  ........................................................ 14
  2. Build and Installation  .............................................. 24
  3. Documentation  ....................................................... 57
  4. Contact  ............................................................. 65


1. Introduction

UAP Common eXtensions provide useful data structures and algorithms for common
programmatic tasks in C language. By design the features are divided into
modules to minimize the library footprint. Using the build files you can create
a static lib containing all modules, but you might also want use the UCX sources
in your project and compile against specific modules to further minimize the
footprint. Feel free to do so.


2. Build and Installation

Untar the source archive and run

  make CONF=<yourconfig>

If you are using gcc, then simply run

  make

The further available configurations are gcc-debug, g++, g++-debug, osx,
osx-debug, suncc, suncc-debug and windows. The later uses microsoft visual C++
compiler. If you want to use mingw oder cygwin, you can use the default gcc
configuration.

The build files are placed into a build subdirectory, which is created if it
does not exists.

To install UCX, run

  make install

or

  make install PREFIX=<install_dir>

The default prefix is /usr/local.

If you want to test you build, run

  make run CONF=<yourconfig>


3. Documentation

The code uses doxygen source code documentation. A html version of the
documentation is also available here:

  http://develop.uap-core.de/ucx/1.0/index.html


4. Contact

Copyright (c) 2013 Olaf Wintermann

  Mike "UniversE" Becker        (universe@uap-core.de)
  Olaf "Prometheus" Wintermann  (prometheus@uap-core.de)