Mercurial > hg > ucx / annotate

README@81d580042da1 (annotated)

README

Sat, 21 Dec 2013 12:31:31 +0100

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Sat, 21 Dec 2013 12:31:31 +0100
changeset 158
81d580042da1
parent 157
ae7cc5716f38
child 159
a22b6da0587e
permissions
-rw-r--r--

Added allocator to mempool struct + fixed suncc.mk

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
155
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
8 1. Introduction ........................................................ 15
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
9 2. Build ............................................................... 25
156
6a4bd1f4c57e removed unnecessary configurations + added build command for shared lib
Mike Becker <universe@uap-core.de>
parents: 155
diff changeset
10 3. Install ............................................................. 56
6a4bd1f4c57e removed unnecessary configurations + added build command for shared lib
Mike Becker <universe@uap-core.de>
parents: 155
diff changeset
11 4. Documentation ....................................................... 68
6a4bd1f4c57e removed unnecessary configurations + added build command for shared lib
Mike Becker <universe@uap-core.de>
parents: 155
diff changeset
12 5. Contact ............................................................. 76
151
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
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
15 1. Introduction
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
16
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
17 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
18 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
19 modules to minimize the library footprint. Using the build files you can create
155
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
20 a static and a shared lib containing all modules, but you might also want use
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
21 the UCX sources in your project and compile specific modules to further minimize
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
22 the 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
23
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24
155
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
25 2. Build
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
26
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
27 Untar the source archive and run
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
28
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
29 make CONF=<yourconfig>
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
30
155
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
31 If you are going to use gcc, then simply run
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
32
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
33 make
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
34
157
ae7cc5716f38 added new mingw config
Mike Becker <universe@uap-core.de>
parents: 156
diff changeset
35 The available configurations are clang, gcc, mingw, osx and suncc.
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
36
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
37 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
38 does not exists.
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
39
155
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
40 The default target builds an optimized binaries. Use the debug target by running
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
41
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
42 make debug CONF=<yourconfig>
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
43
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
44 to disable optimization and enable debug symbols.
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
45
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
46 If you want to test your build either run
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
47
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
48 make run CONF=<yourconfig>
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
49
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
50 or
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
51
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
52 make run-debug CONF=<yourconfig>
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
53
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
54 Again, you can omit the CONF parameter, when using the gcc.
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
55
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
56 3. Install
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
57
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
58 Build the binaries as described in chapter two. Then install UCX, by running
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
59
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
60 make install
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 or
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 make install PREFIX=<install_dir>
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
65
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
66 The default prefix is /usr/local.
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
67
155
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
68 4. Documentation
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
69
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
70 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
71 documentation is also available here:
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
72
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
73 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
74
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
75
155
45395ba5ed30 further improved build system (debug is now a target instead of a configuration)
Mike Becker <universe@uap-core.de>
parents: 152
diff changeset
76 5. Contact
151
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
77
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
78 Copyright (c) 2013 Olaf Wintermann
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
79
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
80 Mike "UniversE" Becker (universe@uap-core.de)
fc8d05972af7 added README file - TODO: make install
Mike Becker <universe@uap-core.de>
parents: 103
diff changeset
81 Olaf "Prometheus" Wintermann (prometheus@uap-core.de)

Mercurial Repository: ucx

mercurial