README@edb9f875b7f9 (annotated)
README
Fri, 12 Apr 2024 21:48:12 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Fri, 12 Apr 2024 21:48:12 +0200
- changeset 849
- edb9f875b7f9
- parent 760
- 52e49533e7b4
- permissions
- -rw-r--r--
improves interface of cx_sprintf() variants
| 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@390 | 8 | 2. Build ............................................................... 25 |
| universe@390 | 9 | 3. Documentation ....................................................... 44 |
| universe@390 | 10 | 4. Contact ............................................................. 57 |
| universe@390 | 11 | 5. License ............................................................. 64 |
| universe@103 | 12 | |
| universe@103 | 13 | |
| universe@151 | 14 | 1. Introduction |
| universe@159 | 15 | --------------- |
| universe@103 | 16 | |
| universe@259 | 17 | With this library we provide useful data structures and algorithms for common |
| universe@259 | 18 | programmatic tasks in the C language. By design the features are divided into |
| universe@151 | 19 | modules to minimize the library footprint. Using the build files you can create |
| universe@259 | 20 | a static and a shared lib containing all modules, but you may also use the UCX |
| universe@259 | 21 | sources in your project and compile specific modules by yourself to further |
| universe@760 | 22 | minimize the footprint, e.g. when you need lists, but do not need hash maps. |
| universe@151 | 23 | |
| universe@151 | 24 | |
| universe@155 | 25 | 2. Build |
| universe@159 | 26 | -------- |
| universe@151 | 27 | |
| universe@760 | 28 | The build processes requires executing a simple configure script and calling |
| universe@760 | 29 | make. You can clone the repository or download the sources from SourceForge. |
| universe@151 | 30 | |
| universe@750 | 31 | wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz |
| universe@750 | 32 | tar -xzf ucx-latest.tar.gz |
| universe@750 | 33 | cd ucx-latest |
| universe@151 | 34 | |
| universe@760 | 35 | Then execute ./configure with the options you like. You can get a list of |
| universe@760 | 36 | all available options with ./configure --help. The recommended configuration |
| universe@760 | 37 | for production builds is ./configure --release. |
| universe@390 | 38 | |
| universe@760 | 39 | ./configure --release |
| universe@760 | 40 | make |
| universe@760 | 41 | make check # only available when built with tests |
| universe@760 | 42 | sudo make install |
| universe@155 | 43 | |
| universe@390 | 44 | 3. Documentation |
| universe@159 | 45 | ---------------- |
| universe@151 | 46 | |
| universe@250 | 47 | Documentation is available at: |
| universe@250 | 48 | |
| universe@250 | 49 | https://develop.uap-core.de/ucx/index.html |
| universe@250 | 50 | |
| universe@151 | 51 | The code uses doxygen source code documentation. A html version of the |
| universe@151 | 52 | documentation is also available here: |
| universe@151 | 53 | |
| universe@250 | 54 | https://develop.uap-core.de/ucx/api/index.html |
| universe@151 | 55 | |
| universe@151 | 56 | |
| universe@390 | 57 | 4. Contact |
| universe@159 | 58 | ---------- |
| universe@151 | 59 | |
| universe@250 | 60 | Olaf Wintermann (olaf.wintermann@gmail.com) |
| universe@250 | 61 | Mike Becker (universe@uap-core.de) |
| universe@159 | 62 | |
| universe@390 | 63 | |
| universe@390 | 64 | 5. License |
| universe@159 | 65 | ---------- |
| universe@159 | 66 | |
| universe@750 | 67 | Copyright 2023 Mike Becker, Olaf Wintermann All rights reserved. |
| universe@159 | 68 | |
| universe@159 | 69 | Redistribution and use in source and binary forms, with or without |
| universe@159 | 70 | modification, are permitted provided that the following conditions are met: |
| universe@159 | 71 | |
| universe@159 | 72 | 1. Redistributions of source code must retain the above copyright |
| universe@159 | 73 | notice, this list of conditions and the following disclaimer. |
| universe@159 | 74 | |
| universe@159 | 75 | 2. Redistributions in binary form must reproduce the above copyright |
| universe@159 | 76 | notice, this list of conditions and the following disclaimer in the |
| universe@159 | 77 | documentation and/or other materials provided with the distribution. |
| universe@159 | 78 | |
| universe@159 | 79 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| universe@159 | 80 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| universe@159 | 81 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| universe@159 | 82 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| universe@159 | 83 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| universe@159 | 84 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| universe@159 | 85 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| universe@159 | 86 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| universe@159 | 87 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| universe@159 | 88 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| universe@159 | 89 | POSSIBILITY OF SUCH DAMAGE. |
