README

Mon, 09 Sep 2013 10:48:08 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 09 Sep 2013 10:48:08 +0200
changeset 155
45395ba5ed30
parent 152
3238f65db163
child 156
6a4bd1f4c57e
permissions
-rw-r--r--

further improved build system (debug is now a target instead of a configuration)


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

0. Table of Contents:

  1. Introduction  ........................................................ 15
  2. Build  ............................................................... 25
  3. Install  ............................................................. 58
  4. Documentation  ....................................................... 70
  5. Contact  ............................................................. 78


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 and a shared lib containing all modules, but you might also want use
the UCX sources in your project and compile specific modules to further minimize
the footprint. Feel free to do so.


2. Build

Untar the source archive and run

  make CONF=<yourconfig>

If you are going to use gcc, then simply run

  make

The available configurations are clang, gcc, g++, osx, suncc 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.

The default target builds an optimized binaries. Use the debug target by running

  make debug CONF=<yourconfig>

to disable optimization and enable debug symbols.

If you want to test your build either run

  make run CONF=<yourconfig>

or

  make run-debug CONF=<yourconfig>

Again, you can omit the CONF parameter, when using the gcc.

3. Install

Build the binaries as described in chapter two. Then install UCX, by running

  make install

or

  make install PREFIX=<install_dir>

The default prefix is /usr/local.

4. 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


5. Contact

Copyright (c) 2013 Olaf Wintermann

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

mercurial