comparison: README
README
- changeset 151
- fc8d05972af7
- parent 103
- 08018864fb91
- child 152
- 3238f65db163
equal
deleted
inserted
replaced
| 150:1cf2eabf94ed | 151:fc8d05972af7 |
|---|---|
| 1 | |
| 2 ------------------------------------------------------------------------------- | |
| 3 UAP Common eXtensions - UCX | |
| 4 ------------------------------------------------------------------------------- | |
| 5 | |
| 6 0. Table of Contents: | |
| 7 | |
| 8 1. Introduction ........................................................ 14 | |
| 9 2. Build and Installation .............................................. 24 | |
| 10 3. Documentation ....................................................... 57 | |
| 11 4. Contact ............................................................. 65 | |
| 12 | |
| 13 | |
| 14 1. Introduction | |
| 15 | |
| 16 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 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 in your project and compile against specific modules to further minimize the | |
| 21 footprint. Feel free to do so. | |
| 22 | |
| 23 | |
| 24 2. Build and Installation | |
| 25 | |
| 26 Untar the source archive and run | |
| 27 | |
| 28 make CONF=<yourconfig> | |
| 29 | |
| 30 If you are using gcc, then simply run | |
| 31 | |
| 32 make | |
| 33 | |
| 34 The further available configurations are gcc-debug, g++, g++-debug, osx, | |
| 35 osx-debug, suncc, suncc-debug and windows. The later uses microsoft visual C++ | |
| 36 compiler. If you want to use mingw oder cygwin, you can use the default gcc | |
| 37 configuration. | |
| 38 | |
| 39 The build files are placed into a build subdirectory, which is created if it | |
| 40 does not exists. | |
| 41 | |
| 42 To install UCX, run | |
| 43 | |
| 44 make install | |
| 45 | |
| 46 or | |
| 47 | |
| 48 make install PREFIX=<install_dir> | |
| 49 | |
| 50 The default prefix is /usr/local. | |
| 51 | |
| 52 If you want to test you build, run | |
| 53 | |
| 54 make run CONF=<yourconfig> | |
| 55 | |
| 56 | |
| 57 3. Documentation | |
| 58 | |
| 59 The code uses doxygen source code documentation. A html version of the | |
| 60 documentation is also available here: | |
| 61 | |
| 62 http://develop.uap-core.de/ucx/1.0/index.html | |
| 63 | |
| 64 | |
| 65 4. Contact | |
| 66 | |
| 67 Copyright (c) 2013 Olaf Wintermann | |
| 68 | |
| 69 Mike "UniversE" Becker (universe@uap-core.de) | |
| 70 Olaf "Prometheus" Wintermann (prometheus@uap-core.de) |
