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