universe@103: 
universe@151: -------------------------------------------------------------------------------
universe@151:                      UAP Common eXtensions - UCX
universe@151: -------------------------------------------------------------------------------
universe@103: 
universe@151: 0. Table of Contents:
universe@103: 
universe@155:   1. Introduction  ........................................................ 15
universe@159:   2. Build  ............................................................... 26
universe@159:   3. Install  ............................................................. 58
universe@159:   4. Documentation  ....................................................... 71
universe@159:   5. Contact  ............................................................. 80
universe@159:   6. License  ............................................................. 89
universe@103: 
universe@103: 
universe@151: 1. Introduction
universe@159: ---------------
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@155: a static and a shared lib containing all modules, but you might also want use
universe@155: the UCX sources in your project and compile specific modules to further minimize
universe@155: the footprint. Feel free to do so.
universe@151: 
universe@151: 
universe@155: 2. Build
universe@159: --------
universe@151: 
universe@151: Untar the source archive and run
universe@151: 
universe@151:   make CONF=<yourconfig>
universe@151: 
universe@155: If you are going to use gcc, then simply run
universe@151: 
universe@151:   make
universe@151: 
universe@157: The available configurations are clang, gcc, mingw, osx and suncc. 
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@175: The default target builds optimized binaries. Use the debug target by running
universe@155: 
universe@155:   make debug CONF=<yourconfig>
universe@155: 
universe@155: to disable optimization and enable debug symbols.
universe@155: 
universe@155: If you want to test your build either run
universe@155: 
universe@155:   make run CONF=<yourconfig>
universe@155: 
universe@155: or
universe@155: 
universe@155:   make run-debug CONF=<yourconfig>
universe@155: 
universe@155: Again, you can omit the CONF parameter, when using the gcc.
universe@155: 
universe@155: 3. Install
universe@159: ----------
universe@155: 
universe@155: Build the binaries as described in chapter two. Then install UCX, by running
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@155: 4. Documentation
universe@159: ----------------
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@175:   http://develop.uap-core.de/ucx/api/current/index.html
universe@151: 
universe@151: 
universe@155: 5. Contact
universe@159: ----------
universe@151: 
universe@151:   Mike "UniversE" Becker        (universe@uap-core.de)
universe@151:   Olaf "Prometheus" Wintermann  (prometheus@uap-core.de)
universe@159: 
universe@159: 6. License
universe@159: ----------
universe@159: 
universe@159: Copyright 2013 Olaf Wintermann. All rights reserved.
universe@159: 
universe@159: Redistribution and use in source and binary forms, with or without
universe@159: modification, are permitted provided that the following conditions are met:
universe@159: 
universe@159:   1. Redistributions of source code must retain the above copyright
universe@159:      notice, this list of conditions and the following disclaimer.
universe@159: 
universe@159:   2. Redistributions in binary form must reproduce the above copyright
universe@159:      notice, this list of conditions and the following disclaimer in the
universe@159:      documentation and/or other materials provided with the distribution.
universe@159: 
universe@159: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@159: AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@159: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@159: ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@159: LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@159: CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@159: SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@159: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@159: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@159: ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@159: POSSIBILITY OF SUCH DAMAGE.