Mon, 09 Sep 2013 11:54:32 +0200
removed unnecessary configurations + added build command for shared lib
2 -------------------------------------------------------------------------------
3 UAP Common eXtensions - UCX
4 -------------------------------------------------------------------------------
6 0. Table of Contents:
8 1. Introduction ........................................................ 15
9 2. Build ............................................................... 25
10 3. Install ............................................................. 56
11 4. Documentation ....................................................... 68
12 5. Contact ............................................................. 76
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, osx and suncc.
37 The build files are placed into a build subdirectory, which is created if it
38 does not exists.
40 The default target builds an optimized binaries. Use the debug target by running
42 make debug CONF=<yourconfig>
44 to disable optimization and enable debug symbols.
46 If you want to test your build either run
48 make run CONF=<yourconfig>
50 or
52 make run-debug CONF=<yourconfig>
54 Again, you can omit the CONF parameter, when using the gcc.
56 3. Install
58 Build the binaries as described in chapter two. Then install UCX, by running
60 make install
62 or
64 make install PREFIX=<install_dir>
66 The default prefix is /usr/local.
68 4. Documentation
70 The code uses doxygen source code documentation. A html version of the
71 documentation is also available here:
73 http://develop.uap-core.de/ucx/1.0/index.html
76 5. Contact
78 Copyright (c) 2013 Olaf Wintermann
80 Mike "UniversE" Becker (universe@uap-core.de)
81 Olaf "Prometheus" Wintermann (prometheus@uap-core.de)