Mercurial > hg > ucx / file diff

--- a/README	Fri Sep 06 17:01:53 2013 +0200
+++ b/README	Mon Sep 09 10:48:08 2013 +0200
@@ -5,10 +5,11 @@
 
 0. Table of Contents:
 
-  1. Introduction  ........................................................ 14
-  2. Build and Installation  .............................................. 24
-  3. Documentation  ....................................................... 57
-  4. Contact  ............................................................. 65
+  1. Introduction  ........................................................ 15
+  2. Build  ............................................................... 25
+  3. Install  ............................................................. 58
+  4. Documentation  ....................................................... 70
+  5. Contact  ............................................................. 78
 
 
 1. Introduction
@@ -16,30 +17,47 @@
 UAP Common eXtensions provide useful data structures and algorithms for common
 programmatic tasks in C language. By design the features are divided into
 modules to minimize the library footprint. Using the build files you can create
-a static lib containing all modules, but you might also want use the UCX sources
-in your project and compile against specific modules to further minimize the
-footprint. Feel free to do so.
+a static and a shared lib containing all modules, but you might also want use
+the UCX sources in your project and compile specific modules to further minimize
+the footprint. Feel free to do so.
 
 
-2. Build and Installation
+2. Build
 
 Untar the source archive and run
 
   make CONF=<yourconfig>
 
-If you are using gcc, then simply run
+If you are going to use gcc, then simply run
 
   make
 
-The available configurations are clang, clang-debug, gcc, gcc-debug, g++,
-g++-debug, osx, osx-debug, suncc, suncc-debug and windows. The later uses
-microsoft visual C++ compiler. If you want to use mingw oder cygwin, you can
-use the default gcc configuration.
+The available configurations are clang, gcc, g++, osx, suncc and windows. The
+later uses microsoft visual C++ compiler. If you want to use mingw oder cygwin,
+you can use the default gcc configuration.
 
 The build files are placed into a build subdirectory, which is created if it
 does not exists.
 
-To install UCX, run
+The default target builds an optimized binaries. Use the debug target by running
+
+  make debug CONF=<yourconfig>
+
+to disable optimization and enable debug symbols.
+
+If you want to test your build either run
+
+  make run CONF=<yourconfig>
+
+or
+
+  make run-debug CONF=<yourconfig>
+
+Again, you can omit the CONF parameter, when using the gcc.
+
+3. Install
+
+Build the binaries as described in chapter two. Then install UCX, by running
 
   make install
 
@@ -49,12 +67,7 @@
 
 The default prefix is /usr/local.
 
-If you want to test your build, run
-
-  make run CONF=<yourconfig>
-
-
-3. Documentation
+4. Documentation
 
 The code uses doxygen source code documentation. A html version of the
 documentation is also available here:
@@ -62,7 +75,7 @@
   http://develop.uap-core.de/ucx/1.0/index.html
 
 
-4. Contact
+5. Contact
 
 Copyright (c) 2013 Olaf Wintermann