README

Fri, 06 Sep 2013 17:01:53 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Fri, 06 Sep 2013 17:01:53 +0200
changeset 154
8346aebfbb7b
parent 152
3238f65db163
child 155
45395ba5ed30
permissions
-rw-r--r--

fixed makefiles

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

mercurial