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

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

mercurial