comparison: README
README
- changeset 159
- a22b6da0587e
- parent 157
- ae7cc5716f38
- child 175
- f5aa799abd86
equal
deleted
inserted
replaced
| 158:81d580042da1 | 159:a22b6da0587e |
|---|---|
| 4 ------------------------------------------------------------------------------- | 4 ------------------------------------------------------------------------------- |
| 5 | 5 |
| 6 0. Table of Contents: | 6 0. Table of Contents: |
| 7 | 7 |
| 8 1. Introduction ........................................................ 15 | 8 1. Introduction ........................................................ 15 |
| 9 2. Build ............................................................... 25 | 9 2. Build ............................................................... 26 |
| 10 3. Install ............................................................. 56 | 10 3. Install ............................................................. 58 |
| 11 4. Documentation ....................................................... 68 | 11 4. Documentation ....................................................... 71 |
| 12 5. Contact ............................................................. 76 | 12 5. Contact ............................................................. 80 |
| 13 6. License ............................................................. 89 | |
| 13 | 14 |
| 14 | 15 |
| 15 1. Introduction | 16 1. Introduction |
| 17 --------------- | |
| 16 | 18 |
| 17 UAP Common eXtensions provide useful data structures and algorithms for common | 19 UAP Common eXtensions provide useful data structures and algorithms for common |
| 18 programmatic tasks in C language. By design the features are divided into | 20 programmatic tasks in C language. By design the features are divided into |
| 19 modules to minimize the library footprint. Using the build files you can create | 21 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 might also want use | 22 a static and a shared lib containing all modules, but you might also want use |
| 21 the UCX sources in your project and compile specific modules to further minimize | 23 the UCX sources in your project and compile specific modules to further minimize |
| 22 the footprint. Feel free to do so. | 24 the footprint. Feel free to do so. |
| 23 | 25 |
| 24 | 26 |
| 25 2. Build | 27 2. Build |
| 28 -------- | |
| 26 | 29 |
| 27 Untar the source archive and run | 30 Untar the source archive and run |
| 28 | 31 |
| 29 make CONF=<yourconfig> | 32 make CONF=<yourconfig> |
| 30 | 33 |
| 52 make run-debug CONF=<yourconfig> | 55 make run-debug CONF=<yourconfig> |
| 53 | 56 |
| 54 Again, you can omit the CONF parameter, when using the gcc. | 57 Again, you can omit the CONF parameter, when using the gcc. |
| 55 | 58 |
| 56 3. Install | 59 3. Install |
| 60 ---------- | |
| 57 | 61 |
| 58 Build the binaries as described in chapter two. Then install UCX, by running | 62 Build the binaries as described in chapter two. Then install UCX, by running |
| 59 | 63 |
| 60 make install | 64 make install |
| 61 | 65 |
| 64 make install PREFIX=<install_dir> | 68 make install PREFIX=<install_dir> |
| 65 | 69 |
| 66 The default prefix is /usr/local. | 70 The default prefix is /usr/local. |
| 67 | 71 |
| 68 4. Documentation | 72 4. Documentation |
| 73 ---------------- | |
| 69 | 74 |
| 70 The code uses doxygen source code documentation. A html version of the | 75 The code uses doxygen source code documentation. A html version of the |
| 71 documentation is also available here: | 76 documentation is also available here: |
| 72 | 77 |
| 73 http://develop.uap-core.de/ucx/1.0/index.html | 78 http://develop.uap-core.de/ucx/1.0/index.html |
| 74 | 79 |
| 75 | 80 |
| 76 5. Contact | 81 5. Contact |
| 77 | 82 ---------- |
| 78 Copyright (c) 2013 Olaf Wintermann | |
| 79 | 83 |
| 80 Mike "UniversE" Becker (universe@uap-core.de) | 84 Mike "UniversE" Becker (universe@uap-core.de) |
| 81 Olaf "Prometheus" Wintermann (prometheus@uap-core.de) | 85 Olaf "Prometheus" Wintermann (prometheus@uap-core.de) |
| 86 | |
| 87 6. License | |
| 88 ---------- | |
| 89 | |
| 90 Copyright 2013 Olaf Wintermann. All rights reserved. | |
| 91 | |
| 92 Redistribution and use in source and binary forms, with or without | |
| 93 modification, are permitted provided that the following conditions are met: | |
| 94 | |
| 95 1. Redistributions of source code must retain the above copyright | |
| 96 notice, this list of conditions and the following disclaimer. | |
| 97 | |
| 98 2. Redistributions in binary form must reproduce the above copyright | |
| 99 notice, this list of conditions and the following disclaimer in the | |
| 100 documentation and/or other materials provided with the distribution. | |
| 101 | |
| 102 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
| 103 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 104 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 105 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
| 106 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
| 107 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
| 108 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
| 109 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
| 110 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
| 111 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
| 112 POSSIBILITY OF SUCH DAMAGE. |
