Thu, 10 Apr 2014 11:32:59 +0200
added more tests for ucx_list_remove
2 -------------------------------------------------------------------------------
3 UAP Common eXtensions - UCX
4 -------------------------------------------------------------------------------
6 0. Table of Contents:
8 1. Introduction ........................................................ 15
9 2. Build ............................................................... 26
10 3. Install ............................................................. 58
11 4. Documentation ....................................................... 71
12 5. Contact ............................................................. 80
13 6. License ............................................................. 89
16 1. Introduction
17 ---------------
19 UAP Common eXtensions provide useful data structures and algorithms for common
20 programmatic tasks in C language. By design the features are divided into
21 modules to minimize the library footprint. Using the build files you can create
22 a static and a shared lib containing all modules, but you might also want use
23 the UCX sources in your project and compile specific modules to further minimize
24 the footprint. Feel free to do so.
27 2. Build
28 --------
30 Untar the source archive and run
32 make CONF=<yourconfig>
34 If you are going to use gcc, then simply run
36 make
38 The available configurations are clang, gcc, mingw, osx and suncc.
40 The build files are placed into a build subdirectory, which is created if it
41 does not exists.
43 The default target builds an optimized binaries. Use the debug target by running
45 make debug CONF=<yourconfig>
47 to disable optimization and enable debug symbols.
49 If you want to test your build either run
51 make run CONF=<yourconfig>
53 or
55 make run-debug CONF=<yourconfig>
57 Again, you can omit the CONF parameter, when using the gcc.
59 3. Install
60 ----------
62 Build the binaries as described in chapter two. Then install UCX, by running
64 make install
66 or
68 make install PREFIX=<install_dir>
70 The default prefix is /usr/local.
72 4. Documentation
73 ----------------
75 The code uses doxygen source code documentation. A html version of the
76 documentation is also available here:
78 http://develop.uap-core.de/ucx/1.0/index.html
81 5. Contact
82 ----------
84 Mike "UniversE" Becker (universe@uap-core.de)
85 Olaf "Prometheus" Wintermann (prometheus@uap-core.de)
87 6. License
88 ----------
90 Copyright 2013 Olaf Wintermann. All rights reserved.
92 Redistribution and use in source and binary forms, with or without
93 modification, are permitted provided that the following conditions are met:
95 1. Redistributions of source code must retain the above copyright
96 notice, this list of conditions and the following disclaimer.
98 2. Redistributions in binary form must reproduce the above copyright
99 notice, this list of conditions and the following disclaimer in the
100 documentation and/or other materials provided with the distribution.
102 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
103 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
104 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
105 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
106 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
107 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
108 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
109 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
110 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
111 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
112 POSSIBILITY OF SUCH DAMAGE.