README

Thu, 08 Sep 2016 15:12:56 +0200

author
Mike Becker <universe@uap-core.de>
date
Thu, 08 Sep 2016 15:12:56 +0200
changeset 225
a1a068c2c4ef
parent 192
1e51558b9d09
child 250
b7d1317b138e
permissions
-rw-r--r--

updates documenting comments

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

mercurial