README

Wed, 22 Aug 2018 14:39:24 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 22 Aug 2018 14:39:24 +0200
changeset 329
71e9a60abfb4
parent 259
2f5dea574a75
child 390
d345541018fa
permissions
-rw-r--r--

adds Eclipse hidden files to .hgignore

151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
1 -------------------------------------------------------------------------------
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
2 UAP Common Extensions - UCX
151
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
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
9 3. Install ............................................................. 37
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
10 4. Documentation ....................................................... 50
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
11 5. Contact ............................................................. 63
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
12 6. License ............................................................. 69
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
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
18 With this library we provide useful data structures and algorithms for common
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
19 programmatic tasks in the C language. By design the features are divided into
151
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
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
21 a static and a shared lib containing all modules, but you may also use the UCX
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
22 sources in your project and compile specific modules by yourself to further
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
23 minimize the footprint.
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
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
29 Untar the source archive and simply run
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
30
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
31 ./configure && make
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
32
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
33 If you want to verify your build, you may then run
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
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
35 make check
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
36
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
37 3. Install
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
38 ----------
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
39
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
40 Build the binaries as described above. Then install UCX, by running
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
41
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
42 make install
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
43
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
44 or
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
45
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
46 make install PREFIX=<install_dir>
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
47
256
2c21b42cf11d documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
48 The default prefix is /usr/local and will require privileged access.
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
49
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
50 4. Documentation
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
51 ----------------
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
52
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
53 Documentation is available at:
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
54
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
55 https://develop.uap-core.de/ucx/index.html
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
56
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
57 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
58 documentation is also available here:
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
59
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
60 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
61
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
62
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
63 5. Contact
159
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
64 ----------
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
65
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
66 Olaf Wintermann (olaf.wintermann@gmail.com)
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
67 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
68
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
69 6. License
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
70 ----------
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
71
259
2f5dea574a75 modules documentation
Mike Becker <universe@uap-core.de>
parents: 256
diff changeset
72 Copyright 2017 Mike Becker, 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
73
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
74 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
75 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
76
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
77 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
78 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
79
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
80 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
81 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
82 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
83
a22b6da0587e added license to readme + added underlines to chapter titles
Mike Becker <universe@uap-core.de>
parents: 157
diff changeset
84 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
85 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
86 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
87 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
88 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
89 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
90 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
91 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
92 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
93 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
94 POSSIBILITY OF SUCH DAMAGE.

mercurial