README@b7d1317b138e (annotated)
README
Tue, 17 Oct 2017 15:15:54 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Tue, 17 Oct 2017 15:15:54 +0200
- changeset 250
- b7d1317b138e
- parent 225
- a1a068c2c4ef
- child 256
- 2c21b42cf11d
- permissions
- -rw-r--r--
updates license
| universe@151 | 1 | ------------------------------------------------------------------------------- |
| universe@151 | 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@159 | 9 | 3. Install ............................................................. 58 |
| universe@159 | 10 | 4. Documentation ....................................................... 71 |
| universe@250 | 11 | 5. Contact ............................................................. 84 |
| universe@250 | 12 | 6. License ............................................................. 90 |
| universe@103 | 13 | |
| universe@103 | 14 | |
| universe@151 | 15 | 1. Introduction |
| universe@159 | 16 | --------------- |
| universe@103 | 17 | |
| universe@151 | 18 | UAP Common eXtensions provide useful data structures and algorithms for common |
| universe@151 | 19 | programmatic tasks in 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@155 | 21 | a static and a shared lib containing all modules, but you might also want use |
| universe@155 | 22 | the UCX sources in your project and compile specific modules to further minimize |
| universe@155 | 23 | the footprint. Feel free to do so. |
| universe@151 | 24 | |
| universe@151 | 25 | |
| universe@155 | 26 | 2. Build |
| universe@159 | 27 | -------- |
| universe@151 | 28 | |
| universe@151 | 29 | Untar the source archive and run |
| universe@151 | 30 | |
| universe@151 | 31 | make CONF=<yourconfig> |
| universe@151 | 32 | |
| universe@155 | 33 | If you are going to use gcc, then simply run |
| universe@151 | 34 | |
| universe@151 | 35 | make |
| universe@151 | 36 | |
| universe@157 | 37 | The available configurations are clang, gcc, mingw, osx and suncc. |
| universe@151 | 38 | |
| universe@151 | 39 | The build files are placed into a build subdirectory, which is created if it |
| universe@151 | 40 | does not exists. |
| universe@151 | 41 | |
| universe@175 | 42 | The default target builds optimized binaries. Use the debug target by running |
| universe@155 | 43 | |
| universe@155 | 44 | make debug CONF=<yourconfig> |
| universe@155 | 45 | |
| universe@155 | 46 | to disable optimization and enable debug symbols. |
| universe@155 | 47 | |
| universe@155 | 48 | If you want to test your build either run |
| universe@155 | 49 | |
| universe@155 | 50 | make run CONF=<yourconfig> |
| universe@155 | 51 | |
| universe@155 | 52 | or |
| universe@155 | 53 | |
| universe@155 | 54 | make run-debug CONF=<yourconfig> |
| universe@155 | 55 | |
| universe@155 | 56 | Again, you can omit the CONF parameter, when using the gcc. |
| universe@155 | 57 | |
| universe@155 | 58 | 3. Install |
| universe@159 | 59 | ---------- |
| universe@155 | 60 | |
| universe@155 | 61 | Build the binaries as described in chapter two. Then install UCX, by running |
| universe@151 | 62 | |
| universe@151 | 63 | make install |
| universe@151 | 64 | |
| universe@151 | 65 | or |
| universe@151 | 66 | |
| universe@151 | 67 | make install PREFIX=<install_dir> |
| universe@151 | 68 | |
| universe@151 | 69 | The default prefix is /usr/local. |
| universe@151 | 70 | |
| universe@155 | 71 | 4. Documentation |
| universe@159 | 72 | ---------------- |
| universe@151 | 73 | |
| universe@250 | 74 | Documentation is available at: |
| universe@250 | 75 | |
| universe@250 | 76 | https://develop.uap-core.de/ucx/index.html |
| universe@250 | 77 | |
| universe@151 | 78 | The code uses doxygen source code documentation. A html version of the |
| universe@151 | 79 | documentation is also available here: |
| universe@151 | 80 | |
| universe@250 | 81 | https://develop.uap-core.de/ucx/api/index.html |
| universe@151 | 82 | |
| universe@151 | 83 | |
| universe@155 | 84 | 5. Contact |
| universe@159 | 85 | ---------- |
| universe@151 | 86 | |
| universe@250 | 87 | Olaf Wintermann (olaf.wintermann@gmail.com) |
| universe@250 | 88 | Mike Becker (universe@uap-core.de) |
| universe@159 | 89 | |
| universe@159 | 90 | 6. License |
| universe@159 | 91 | ---------- |
| universe@159 | 92 | |
| universe@250 | 93 | Copyright 2017 Olaf Wintermann. All rights reserved. |
| universe@159 | 94 | |
| universe@159 | 95 | Redistribution and use in source and binary forms, with or without |
| universe@159 | 96 | modification, are permitted provided that the following conditions are met: |
| universe@159 | 97 | |
| universe@159 | 98 | 1. Redistributions of source code must retain the above copyright |
| universe@159 | 99 | notice, this list of conditions and the following disclaimer. |
| universe@159 | 100 | |
| universe@159 | 101 | 2. Redistributions in binary form must reproduce the above copyright |
| universe@159 | 102 | notice, this list of conditions and the following disclaimer in the |
| universe@159 | 103 | documentation and/or other materials provided with the distribution. |
| universe@159 | 104 | |
| universe@159 | 105 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| universe@159 | 106 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| universe@159 | 107 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| universe@159 | 108 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| universe@159 | 109 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| universe@159 | 110 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| universe@159 | 111 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| universe@159 | 112 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| universe@159 | 113 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| universe@159 | 114 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| universe@159 | 115 | POSSIBILITY OF SUCH DAMAGE. |
