comparison: README
README
- changeset 1198
- d73620697593
- parent 760
- 52e49533e7b4
equal
deleted
inserted
replaced
| 1197:6dadac4864dc | 1198:d73620697593 |
|---|---|
| 2 UAP Common Extensions - UCX | 2 UAP Common Extensions - UCX |
| 3 ------------------------------------------------------------------------------- | 3 ------------------------------------------------------------------------------- |
| 4 | 4 |
| 5 0. Table of Contents: | 5 0. Table of Contents: |
| 6 | 6 |
| 7 1. Introduction ........................................................ 15 | 7 1. Introduction ........................................................ 14 |
| 8 2. Build ............................................................... 25 | 8 2. Build ............................................................... 22 |
| 9 3. Documentation ....................................................... 44 | 9 3. Documentation ....................................................... 44 |
| 10 4. Contact ............................................................. 57 | 10 4. Contact ............................................................. 57 |
| 11 5. License ............................................................. 64 | 11 5. License ............................................................. 64 |
| 12 | 12 |
| 13 | 13 |
| 14 1. Introduction | 14 1. Introduction |
| 15 --------------- | 15 --------------- |
| 16 | 16 |
| 17 With this library we provide useful data structures and algorithms for common | 17 With this library we provide useful data structures and algorithms for common |
| 18 programmatic tasks in the C language. By design the features are divided into | 18 programmatic tasks in the C language. Using the build files you can create |
| 19 modules to minimize the library footprint. Using the build files you can create | 19 a static and a shared lib containing all units, but you may also use the UCX |
| 20 a static and a shared lib containing all modules, but you may also use the UCX | 20 sources in your project and compile specific units by yourself. |
| 21 sources in your project and compile specific modules by yourself to further | |
| 22 minimize the footprint, e.g. when you need lists, but do not need hash maps. | |
| 23 | |
| 24 | 21 |
| 25 2. Build | 22 2. Build |
| 26 -------- | 23 -------- |
| 27 | 24 |
| 28 The build processes requires executing a simple configure script and calling | 25 The build processes requires executing a simple configure script and calling |
| 39 ./configure --release | 36 ./configure --release |
| 40 make | 37 make |
| 41 make check # only available when built with tests | 38 make check # only available when built with tests |
| 42 sudo make install | 39 sudo make install |
| 43 | 40 |
| 41 For Windows builds there is Visual Studio Solution available in the msvc | |
| 42 directory. | |
| 43 | |
| 44 3. Documentation | 44 3. Documentation |
| 45 ---------------- | 45 ---------------- |
| 46 | 46 |
| 47 Documentation is available at: | 47 Documentation is available at: |
| 48 | 48 |
| 49 https://develop.uap-core.de/ucx/index.html | 49 https://ucx.sourceforge.io |
| 50 | 50 |
| 51 The code uses doxygen source code documentation. A html version of the | 51 The code uses doxygen source code documentation. A html version of the |
| 52 documentation is also available here: | 52 documentation is also available here: |
| 53 | 53 |
| 54 https://develop.uap-core.de/ucx/api/index.html | 54 https://ucx.sourceforge.io/api/ |
| 55 | 55 |
| 56 | 56 |
| 57 4. Contact | 57 4. Contact |
| 58 ---------- | 58 ---------- |
| 59 | 59 |
| 62 | 62 |
| 63 | 63 |
| 64 5. License | 64 5. License |
| 65 ---------- | 65 ---------- |
| 66 | 66 |
| 67 Copyright 2023 Mike Becker, Olaf Wintermann All rights reserved. | 67 Copyright 2025 Mike Becker, Olaf Wintermann All rights reserved. |
| 68 | 68 |
| 69 Redistribution and use in source and binary forms, with or without | 69 Redistribution and use in source and binary forms, with or without |
| 70 modification, are permitted provided that the following conditions are met: | 70 modification, are permitted provided that the following conditions are met: |
| 71 | 71 |
| 72 1. Redistributions of source code must retain the above copyright | 72 1. Redistributions of source code must retain the above copyright |
