Wed, 18 Oct 2017 19:10:29 +0200
fixes include path and non-cpp build for test program
1 -------------------------------------------------------------------------------
2 UAP Common eXtensions - UCX
3 -------------------------------------------------------------------------------
5 0. Table of Contents:
7 1. Introduction ........................................................ 15
8 2. Build ............................................................... 26
9 3. Install ............................................................. 58
10 4. Documentation ....................................................... 71
11 5. Contact ............................................................. 84
12 6. License ............................................................. 90
15 1. Introduction
16 ---------------
18 UAP Common eXtensions provide useful data structures and algorithms for common
19 programmatic tasks in C language. By design the features are divided into
20 modules to minimize the library footprint. Using the build files you can create
21 a static and a shared lib containing all modules, but you might also want use
22 the UCX sources in your project and compile specific modules to further minimize
23 the footprint. Feel free to do so.
26 2. Build
27 --------
29 Untar the source archive and run
31 make CONF=<yourconfig>
33 If you are going to use gcc, then simply run
35 make
37 The available configurations are clang, gcc, mingw, osx and suncc.
39 The build files are placed into a build subdirectory, which is created if it
40 does not exists.
42 The default target builds 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
59 ----------
61 Build the binaries as described in chapter two. Then install UCX, by running
63 make install
65 or
67 make install PREFIX=<install_dir>
69 The default prefix is /usr/local.
71 4. Documentation
72 ----------------
74 Documentation is available at:
76 https://develop.uap-core.de/ucx/index.html
78 The code uses doxygen source code documentation. A html version of the
79 documentation is also available here:
81 https://develop.uap-core.de/ucx/api/index.html
84 5. Contact
85 ----------
87 Olaf Wintermann (olaf.wintermann@gmail.com)
88 Mike Becker (universe@uap-core.de)
90 6. License
91 ----------
93 Copyright 2017 Olaf Wintermann. All rights reserved.
95 Redistribution and use in source and binary forms, with or without
96 modification, are permitted provided that the following conditions are met:
98 1. Redistributions of source code must retain the above copyright
99 notice, this list of conditions and the following disclaimer.
101 2. Redistributions in binary form must reproduce the above copyright
102 notice, this list of conditions and the following disclaimer in the
103 documentation and/or other materials provided with the distribution.
105 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
106 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
107 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
108 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
109 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
110 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
111 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
112 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
113 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
114 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
115 POSSIBILITY OF SUCH DAMAGE.