ucx: README@45395ba5ed30

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

     2 -------------------------------------------------------------------------------

     3                      UAP Common eXtensions - UCX

     4 -------------------------------------------------------------------------------

     6 0. Table of Contents:

     8   1. Introduction  ........................................................ 15

     9   2. Build  ............................................................... 25

    10   3. Install  ............................................................. 58

    11   4. Documentation  ....................................................... 70

    12   5. Contact  ............................................................. 78

    15 1. Introduction

    17 UAP Common eXtensions provide useful data structures and algorithms for common

    18 programmatic tasks in C language. By design the features are divided into

    19 modules to minimize the library footprint. Using the build files you can create

    20 a static and a shared lib containing all modules, but you might also want use

    21 the UCX sources in your project and compile specific modules to further minimize

    22 the footprint. Feel free to do so.

    25 2. Build

    27 Untar the source archive and run

    29   make CONF=<yourconfig>

    31 If you are going to use gcc, then simply run

    33   make

    35 The available configurations are clang, gcc, g++, osx, suncc and windows. The

    36 later uses microsoft visual C++ compiler. If you want to use mingw oder cygwin,

    37 you can use the default gcc configuration.

    39 The build files are placed into a build subdirectory, which is created if it

    40 does not exists.

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

    44   make debug CONF=<yourconfig>

    46 to disable optimization and enable debug symbols.

    48 If you want to test your build either run

    50   make run CONF=<yourconfig>

    52 or

    54   make run-debug CONF=<yourconfig>

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

    58 3. Install

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

    62   make install

    64 or

    66   make install PREFIX=<install_dir>

    68 The default prefix is /usr/local.

    70 4. Documentation

    72 The code uses doxygen source code documentation. A html version of the

    73 documentation is also available here:

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

    78 5. Contact

    80 Copyright (c) 2013 Olaf Wintermann

    82   Mike "UniversE" Becker        (universe@uap-core.de)

    83   Olaf "Prometheus" Wintermann  (prometheus@uap-core.de)

Mercurial > hg > ucx / file revision