Mercurial > hg > ucx / changeset

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Thu Sep 05 13:55:04 2013 +0200
     1.3 @@ -0,0 +1,70 @@
     1.4 +
     1.5 +-------------------------------------------------------------------------------
     1.6 +                     UAP Common eXtensions - UCX
     1.7 +-------------------------------------------------------------------------------
     1.8 +
     1.9 +0. Table of Contents:
    1.10 +
    1.11 +  1. Introduction  ........................................................ 14
    1.12 +  2. Build and Installation  .............................................. 24
    1.13 +  3. Documentation  ....................................................... 57
    1.14 +  4. Contact  ............................................................. 65
    1.15 +
    1.16 +
    1.17 +1. Introduction
    1.18 +
    1.19 +UAP Common eXtensions provide useful data structures and algorithms for common
    1.20 +programmatic tasks in C language. By design the features are divided into
    1.21 +modules to minimize the library footprint. Using the build files you can create
    1.22 +a static lib containing all modules, but you might also want use the UCX sources
    1.23 +in your project and compile against specific modules to further minimize the
    1.24 +footprint. Feel free to do so.
    1.25 +
    1.26 +
    1.27 +2. Build and Installation
    1.28 +
    1.29 +Untar the source archive and run
    1.30 +
    1.31 +  make CONF=<yourconfig>
    1.32 +
    1.33 +If you are using gcc, then simply run
    1.34 +
    1.35 +  make
    1.36 +
    1.37 +The further available configurations are gcc-debug, g++, g++-debug, osx,
    1.38 +osx-debug, suncc, suncc-debug and windows. The later uses microsoft visual C++
    1.39 +compiler. If you want to use mingw oder cygwin, you can use the default gcc
    1.40 +configuration.
    1.41 +
    1.42 +The build files are placed into a build subdirectory, which is created if it
    1.43 +does not exists.
    1.44 +
    1.45 +To install UCX, run
    1.46 +
    1.47 +  make install
    1.48 +
    1.49 +or
    1.50 +
    1.51 +  make install PREFIX=<install_dir>
    1.52 +
    1.53 +The default prefix is /usr/local.
    1.54 +
    1.55 +If you want to test you build, run
    1.56 +
    1.57 +  make run CONF=<yourconfig>
    1.58 +
    1.59 +
    1.60 +3. Documentation
    1.61 +
    1.62 +The code uses doxygen source code documentation. A html version of the
    1.63 +documentation is also available here:
    1.64 +
    1.65 +  http://develop.uap-core.de/ucx/1.0/index.html
    1.66 +
    1.67 +
    1.68 +4. Contact
    1.69 +
    1.70 +Copyright (c) 2013 Olaf Wintermann
    1.71 +
    1.72 +  Mike "UniversE" Becker        (universe@uap-core.de)
    1.73 +  Olaf "Prometheus" Wintermann  (prometheus@uap-core.de)

     2.1 --- a/ucx/ucx.h	Mon Aug 19 13:41:53 2013 +0200
     2.2 +++ b/ucx/ucx.h	Thu Sep 05 13:55:04 2013 +0200
     2.3 @@ -36,6 +36,15 @@
     2.4  #ifndef UCX_H
     2.5  #define	UCX_H
     2.6  
     2.7 +/** Major UCX version as integer constant. */
     2.8 +#define UCX_VERSION_MAJOR   1
     2.9 +
    2.10 +/** Minor UCX version as integer constant. */
    2.11 +#define UCX_VERSION_MINOR   0
    2.12 +
    2.13 +/** The UCX version in format [major].[minor] */
    2.14 +#define UCX_VERSION UCX_VERSION_MAJOR.UCX_VERSION_MINOR
    2.15 +
    2.16  #include <stdlib.h>
    2.17  
    2.18  #ifdef _WIN32