README@6a4bd1f4c57e (annotated)
README
Mon, 09 Sep 2013 11:54:32 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Mon, 09 Sep 2013 11:54:32 +0200
- changeset 156
- 6a4bd1f4c57e
- parent 155
- 45395ba5ed30
- child 157
- ae7cc5716f38
- permissions
- -rw-r--r--
removed unnecessary configurations + added build command for shared lib
| universe@103 | 1 | |
| universe@151 | 2 | ------------------------------------------------------------------------------- |
| universe@151 | 3 | UAP Common eXtensions - UCX |
| universe@151 | 4 | ------------------------------------------------------------------------------- |
| universe@103 | 5 | |
| universe@151 | 6 | 0. Table of Contents: |
| universe@103 | 7 | |
| universe@155 | 8 | 1. Introduction ........................................................ 15 |
| universe@155 | 9 | 2. Build ............................................................... 25 |
| universe@156 | 10 | 3. Install ............................................................. 56 |
| universe@156 | 11 | 4. Documentation ....................................................... 68 |
| universe@156 | 12 | 5. Contact ............................................................. 76 |
| universe@103 | 13 | |
| universe@103 | 14 | |
| universe@151 | 15 | 1. Introduction |
| universe@103 | 16 | |
| universe@151 | 17 | UAP Common eXtensions provide useful data structures and algorithms for common |
| universe@151 | 18 | programmatic tasks in 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@155 | 20 | a static and a shared lib containing all modules, but you might also want use |
| universe@155 | 21 | the UCX sources in your project and compile specific modules to further minimize |
| universe@155 | 22 | the footprint. Feel free to do so. |
| universe@151 | 23 | |
| universe@151 | 24 | |
| universe@155 | 25 | 2. Build |
| universe@151 | 26 | |
| universe@151 | 27 | Untar the source archive and run |
| universe@151 | 28 | |
| universe@151 | 29 | make CONF=<yourconfig> |
| universe@151 | 30 | |
| universe@155 | 31 | If you are going to use gcc, then simply run |
| universe@151 | 32 | |
| universe@151 | 33 | make |
| universe@151 | 34 | |
| universe@156 | 35 | The available configurations are clang, gcc, osx and suncc. |
| universe@151 | 36 | |
| universe@151 | 37 | The build files are placed into a build subdirectory, which is created if it |
| universe@151 | 38 | does not exists. |
| universe@151 | 39 | |
| universe@155 | 40 | The default target builds an optimized binaries. Use the debug target by running |
| universe@155 | 41 | |
| universe@155 | 42 | make debug CONF=<yourconfig> |
| universe@155 | 43 | |
| universe@155 | 44 | to disable optimization and enable debug symbols. |
| universe@155 | 45 | |
| universe@155 | 46 | If you want to test your build either run |
| universe@155 | 47 | |
| universe@155 | 48 | make run CONF=<yourconfig> |
| universe@155 | 49 | |
| universe@155 | 50 | or |
| universe@155 | 51 | |
| universe@155 | 52 | make run-debug CONF=<yourconfig> |
| universe@155 | 53 | |
| universe@155 | 54 | Again, you can omit the CONF parameter, when using the gcc. |
| universe@155 | 55 | |
| universe@155 | 56 | 3. Install |
| universe@155 | 57 | |
| universe@155 | 58 | Build the binaries as described in chapter two. Then install UCX, by running |
| universe@151 | 59 | |
| universe@151 | 60 | make install |
| universe@151 | 61 | |
| universe@151 | 62 | or |
| universe@151 | 63 | |
| universe@151 | 64 | make install PREFIX=<install_dir> |
| universe@151 | 65 | |
| universe@151 | 66 | The default prefix is /usr/local. |
| universe@151 | 67 | |
| universe@155 | 68 | 4. Documentation |
| universe@151 | 69 | |
| universe@151 | 70 | The code uses doxygen source code documentation. A html version of the |
| universe@151 | 71 | documentation is also available here: |
| universe@151 | 72 | |
| universe@151 | 73 | http://develop.uap-core.de/ucx/1.0/index.html |
| universe@151 | 74 | |
| universe@151 | 75 | |
| universe@155 | 76 | 5. Contact |
| universe@151 | 77 | |
| universe@151 | 78 | Copyright (c) 2013 Olaf Wintermann |
| universe@151 | 79 | |
| universe@151 | 80 | Mike "UniversE" Becker (universe@uap-core.de) |
| universe@151 | 81 | Olaf "Prometheus" Wintermann (prometheus@uap-core.de) |
