README

Tue, 17 Oct 2017 16:15:41 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 17 Oct 2017 16:15:41 +0200
changeset 251
fae240d633fc
parent 250
b7d1317b138e
child 256
2c21b42cf11d
permissions
-rw-r--r--

changes source directory structure in preperation for autotools rollout

151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
1 -------------------------------------------------------------------------------
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
2 UAP Common eXtensions - UCX
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
3 -------------------------------------------------------------------------------
103
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
5 0. Table of Contents:
103
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6
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
7 1. Introduction ........................................................ 15
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
8 2. Build ............................................................... 26
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
9 3. Install ............................................................. 58
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
10 4. Documentation ....................................................... 71
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
11 5. Contact ............................................................. 84
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
12 6. License ............................................................. 90
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
13
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 1. Introduction
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
16 ---------------
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
17
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
18 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
19 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
20 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
21 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
22 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
23 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
24
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25
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
26 2. Build
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
27 --------
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
28
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
29 Untar the source archive and run
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
30
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
31 make CONF=<yourconfig>
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
32
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
33 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
34
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
35 make
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
36
157
ae7cc5716f38 added new mingw config
Mike Becker <universe@uap-core.de>
parents: 156
diff changeset
37 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
38
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
39 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
40 does not exists.
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
41
175
f5aa799abd86 adjusted README
Mike Becker <universe@uap-core.de>
parents: 159
diff changeset
42 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
43
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 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
45
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 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
47
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 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
49
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 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
51
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 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
53
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 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
55
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 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
57
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 3. Install
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
59 ----------
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
60
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 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
62
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
63 make install
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
64
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
65 or
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
66
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
67 make install PREFIX=<install_dir>
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
68
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
69 The default prefix is /usr/local.
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
70
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
71 4. Documentation
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
72 ----------------
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
73
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
74 Documentation is available at:
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
75
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
76 https://develop.uap-core.de/ucx/index.html
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
77
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
78 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
79 documentation is also available here:
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
80
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
81 https://develop.uap-core.de/ucx/api/index.html
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
82
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
83
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
84 5. Contact
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
85 ----------
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
86
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
87 Olaf Wintermann (olaf.wintermann@gmail.com)
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
88 Mike Becker (universe@uap-core.de)
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
89
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
90 6. License
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
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
93 Copyright 2017 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
94
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
95 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
96 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
97
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
98 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
99 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
100
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
101 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
102 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
103 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
104
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
105 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
106 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
107 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
108 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
109 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
110 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
111 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
112 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
113 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
114 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
115 POSSIBILITY OF SUCH DAMAGE.

mercurial