UNIXworkcode

1 ------------------------------------------------------------------------------- 2 UAP Common Extensions - UCX 3 ------------------------------------------------------------------------------- 4 5 0. Table of Contents: 6 7 1. Introduction ........................................................ 15 8 2. Build ............................................................... 25 9 3. Documentation ....................................................... 44 10 4. Contact ............................................................. 57 11 5. License ............................................................. 64 12 13 14 1. Introduction 15 --------------- 16 17 With this library we provide useful data structures and algorithms for common 18 programmatic tasks in the C language. By design the features are divided into 19 modules to minimize the library footprint. Using the build files you can create 20 a static and a shared lib containing all modules, but you may also use the UCX 21 sources in your project and compile specific modules by yourself to further 22 minimize the footprint. 23 24 25 2. Build 26 -------- 27 28 Untar the source archive and run 29 30 mkdir build 31 cd build 32 cmake .. 33 make 34 35 Optionally install UCX by running the following command as privileged user 36 37 make install 38 39 If you want to verify your build, you can run 40 41 make test 42 43 44 3. Documentation 45 ---------------- 46 47 Documentation is available at: 48 49 https://develop.uap-core.de/ucx/index.html 50 51 The code uses doxygen source code documentation. A html version of the 52 documentation is also available here: 53 54 https://develop.uap-core.de/ucx/api/index.html 55 56 57 4. Contact 58 ---------- 59 60 Olaf Wintermann (olaf.wintermann@gmail.com) 61 Mike Becker (universe@uap-core.de) 62 63 64 5. License 65 ---------- 66 67 Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. 68 69 Redistribution and use in source and binary forms, with or without 70 modification, are permitted provided that the following conditions are met: 71 72 1. Redistributions of source code must retain the above copyright 73 notice, this list of conditions and the following disclaimer. 74 75 2. Redistributions in binary form must reproduce the above copyright 76 notice, this list of conditions and the following disclaimer in the 77 documentation and/or other materials provided with the distribution. 78 79 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 80 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 81 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 82 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 83 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 84 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 85 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 86 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 87 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 88 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 89 POSSIBILITY OF SUCH DAMAGE. 90