README

Mon, 14 May 2018 13:15:32 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 14 May 2018 13:15:32 +0200
changeset 304
1f9237cfeb26
parent 259
2f5dea574a75
child 390
d345541018fa
permissions
-rw-r--r--

fixes typo in modules.md

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

mercurial