README@fc8d05972af7 (annotated)
README
Thu, 05 Sep 2013 13:55:04 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Thu, 05 Sep 2013 13:55:04 +0200
- changeset 151
- fc8d05972af7
- parent 103
- LICENSE@08018864fb91
- child 152
- 3238f65db163
- permissions
- -rw-r--r--
added README file - TODO: make install
| 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@151 | 8 | 1. Introduction ........................................................ 14 |
| universe@151 | 9 | 2. Build and Installation .............................................. 24 |
| universe@151 | 10 | 3. Documentation ....................................................... 57 |
| universe@151 | 11 | 4. Contact ............................................................. 65 |
| universe@103 | 12 | |
| universe@103 | 13 | |
| universe@151 | 14 | 1. Introduction |
| universe@103 | 15 | |
| universe@151 | 16 | UAP Common eXtensions provide useful data structures and algorithms for common |
| universe@151 | 17 | programmatic tasks in C language. By design the features are divided into |
| universe@151 | 18 | modules to minimize the library footprint. Using the build files you can create |
| universe@151 | 19 | a static lib containing all modules, but you might also want use the UCX sources |
| universe@151 | 20 | in your project and compile against specific modules to further minimize the |
| universe@151 | 21 | footprint. Feel free to do so. |
| universe@151 | 22 | |
| universe@151 | 23 | |
| universe@151 | 24 | 2. Build and Installation |
| universe@151 | 25 | |
| universe@151 | 26 | Untar the source archive and run |
| universe@151 | 27 | |
| universe@151 | 28 | make CONF=<yourconfig> |
| universe@151 | 29 | |
| universe@151 | 30 | If you are using gcc, then simply run |
| universe@151 | 31 | |
| universe@151 | 32 | make |
| universe@151 | 33 | |
| universe@151 | 34 | The further available configurations are gcc-debug, g++, g++-debug, osx, |
| universe@151 | 35 | osx-debug, suncc, suncc-debug and windows. The later uses microsoft visual C++ |
| universe@151 | 36 | compiler. If you want to use mingw oder cygwin, you can use the default gcc |
| universe@151 | 37 | configuration. |
| universe@151 | 38 | |
| universe@151 | 39 | The build files are placed into a build subdirectory, which is created if it |
| universe@151 | 40 | does not exists. |
| universe@151 | 41 | |
| universe@151 | 42 | To install UCX, run |
| universe@151 | 43 | |
| universe@151 | 44 | make install |
| universe@151 | 45 | |
| universe@151 | 46 | or |
| universe@151 | 47 | |
| universe@151 | 48 | make install PREFIX=<install_dir> |
| universe@151 | 49 | |
| universe@151 | 50 | The default prefix is /usr/local. |
| universe@151 | 51 | |
| universe@151 | 52 | If you want to test you build, run |
| universe@151 | 53 | |
| universe@151 | 54 | make run CONF=<yourconfig> |
| universe@151 | 55 | |
| universe@151 | 56 | |
| universe@151 | 57 | 3. Documentation |
| universe@151 | 58 | |
| universe@151 | 59 | The code uses doxygen source code documentation. A html version of the |
| universe@151 | 60 | documentation is also available here: |
| universe@151 | 61 | |
| universe@151 | 62 | http://develop.uap-core.de/ucx/1.0/index.html |
| universe@151 | 63 | |
| universe@151 | 64 | |
| universe@151 | 65 | 4. Contact |
| universe@151 | 66 | |
| universe@151 | 67 | Copyright (c) 2013 Olaf Wintermann |
| universe@151 | 68 | |
| universe@151 | 69 | Mike "UniversE" Becker (universe@uap-core.de) |
| universe@151 | 70 | Olaf "Prometheus" Wintermann (prometheus@uap-core.de) |
