Move macros to subdirectory
[u/mrichter/AliRoot.git] / HLT / README
CommitLineData
b521659f 1Package: ALICE HLT
2
3This package implements the ALICE High Level Trigger framework.
4All contributions are under the terms of the
5GNU General Public License as published by the Free Software
6Foundation. Also see files AUTHORS and THANKS.
7
8This packages is maintained by Matthias.Richter@ift.uib.no
9Comments, bug reports, suggestions welcome!
10
11Overview
12========
13This package provides is a compilation of shared libraries of the ALICE
08e73b29 14HLT project and is intended for stand-alone compilation, i.e. not as part
15of the AliRoot compilation.
16
b521659f 17- BASE: The base library (libHLTbase.so) provides the common interface for HLT
18processing components, the binding into the ALICE offline project AliRoot
19and a pure C interface to the HLT on-line framework (Publisher/Subscriber
20framework)
08e73b29 21
b521659f 22- SampleLib: The sample library contains examples for component
23implementation and a tutorial.
08e73b29 24
b521659f 25- TPCLib: The HLT code for the TPC
26
08e73b29 27Currently, the the package is not included to the standard AliRoot
28compilation, but will be part of it.
29
30The old stand-alone build system is still available. Check the README
31file in the doc folder.
32
33Requirements
34============
35The package needs both ROOT and AliRoot. Both must be set up in the
36usual way (ROOTSYS, ALICE_ROOT, library locations evtl. specified in
37LD_LIBRARY_PATH, ...). Actually, the BASE and SampleLib modules are
38not dependend on AliRoot. The TPCLib does.
39
b521659f 40Setting up a version retrieved from CVS
41=======================================
42Skip this section if you have started from the tar ball.
43
44A version checked out from CVS requires a few steps to set up the Makefiles
45and to set some links which are related to the CVS structure at the IFT.
46Go to the directory and run
47autoreconf -i -f
48
49Then continue with the package configuration described in the 'Installation'
50section.
51
52Modifying a distributed package
53===============================
54If you are going the modify a distributed package you might need to re-make
55the GNU build system by running
56 autoreconf -f -i
57
58Please notify the authors about bug fixes/corrections/extensions you made if
59you consider them worth to be merged into the project.
60
61Then continue with the package configuration described in the 'Installation'
62section.
63
64Installation
65============
66Package build relies on the GNU triplet configure, make and make install.
67It is suggested to use a separate build directory, e.g. from the
68top directory do
69
70 mkdir build
71 cd build
72 ../configure
73 make
74 make install
75
08e73b29 76The default install directories are set to the current directory ($PWD).
b521659f 77
78To override the default prefix use
79--prefix=<dir>
80
81Some important options:
82--enable-logging # Enable/Disable logging (default enabled)
83--enable-sample # Compile the sample library
84--enable-tpc # Compile the TPC library
85
08e73b29 86Note: You can have several build directories with different configure options,
87but using the same source code.
88
b521659f 89If you need further information on the GNU build system, execute from the
90top directory:
91./configure --help | less
92
93
08e73b29 94Documentation
95=============
96Documentation is generated from the source code at compile time if
97doxygen is installed on the machine. From the build directory, open
98doc/html/index.html with a web browser.
99
b521659f 100Further information
101===================
102A wiki with detailed information is set up at
103http://www.kip.uni-heidelberg.de/wiki/HLT