1.1 --- a/README Fri Sep 06 17:01:53 2013 +0200
1.2 +++ b/README Mon Sep 09 10:48:08 2013 +0200
1.3 @@ -5,10 +5,11 @@
1.4
1.5 0. Table of Contents:
1.6
1.7 - 1. Introduction ........................................................ 14
1.8 - 2. Build and Installation .............................................. 24
1.9 - 3. Documentation ....................................................... 57
1.10 - 4. Contact ............................................................. 65
1.11 + 1. Introduction ........................................................ 15
1.12 + 2. Build ............................................................... 25
1.13 + 3. Install ............................................................. 58
1.14 + 4. Documentation ....................................................... 70
1.15 + 5. Contact ............................................................. 78
1.16
1.17
1.18 1. Introduction
1.19 @@ -16,30 +17,47 @@
1.20 UAP Common eXtensions provide useful data structures and algorithms for common
1.21 programmatic tasks in C language. By design the features are divided into
1.22 modules to minimize the library footprint. Using the build files you can create
1.23 -a static lib containing all modules, but you might also want use the UCX sources
1.24 -in your project and compile against specific modules to further minimize the
1.25 -footprint. Feel free to do so.
1.26 +a static and a shared lib containing all modules, but you might also want use
1.27 +the UCX sources in your project and compile specific modules to further minimize
1.28 +the footprint. Feel free to do so.
1.29
1.30
1.31 -2. Build and Installation
1.32 +2. Build
1.33
1.34 Untar the source archive and run
1.35
1.36 make CONF=<yourconfig>
1.37
1.38 -If you are using gcc, then simply run
1.39 +If you are going to use gcc, then simply run
1.40
1.41 make
1.42
1.43 -The available configurations are clang, clang-debug, gcc, gcc-debug, g++,
1.44 -g++-debug, osx, osx-debug, suncc, suncc-debug and windows. The later uses
1.45 -microsoft visual C++ compiler. If you want to use mingw oder cygwin, you can
1.46 -use the default gcc configuration.
1.47 +The available configurations are clang, gcc, g++, osx, suncc and windows. The
1.48 +later uses microsoft visual C++ compiler. If you want to use mingw oder cygwin,
1.49 +you can use the default gcc configuration.
1.50
1.51 The build files are placed into a build subdirectory, which is created if it
1.52 does not exists.
1.53
1.54 -To install UCX, run
1.55 +The default target builds an optimized binaries. Use the debug target by running
1.56 +
1.57 + make debug CONF=<yourconfig>
1.58 +
1.59 +to disable optimization and enable debug symbols.
1.60 +
1.61 +If you want to test your build either run
1.62 +
1.63 + make run CONF=<yourconfig>
1.64 +
1.65 +or
1.66 +
1.67 + make run-debug CONF=<yourconfig>
1.68 +
1.69 +Again, you can omit the CONF parameter, when using the gcc.
1.70 +
1.71 +3. Install
1.72 +
1.73 +Build the binaries as described in chapter two. Then install UCX, by running
1.74
1.75 make install
1.76
1.77 @@ -49,12 +67,7 @@
1.78
1.79 The default prefix is /usr/local.
1.80
1.81 -If you want to test your build, run
1.82 -
1.83 - make run CONF=<yourconfig>
1.84 -
1.85 -
1.86 -3. Documentation
1.87 +4. Documentation
1.88
1.89 The code uses doxygen source code documentation. A html version of the
1.90 documentation is also available here:
1.91 @@ -62,7 +75,7 @@
1.92 http://develop.uap-core.de/ucx/1.0/index.html
1.93
1.94
1.95 -4. Contact
1.96 +5. Contact
1.97
1.98 Copyright (c) 2013 Olaf Wintermann
1.99
