stand-alone compilation converted to autotools; doxygen setup added for documentation...
[u/mrichter/AliRoot.git] / HLT / README
1 Package: ALICE HLT
2
3 This package implements the ALICE High Level Trigger framework.
4 All contributions are under the terms of the 
5 GNU General Public License as published by the Free Software 
6 Foundation. Also see files AUTHORS and THANKS.
7
8 This packages is maintained by Matthias.Richter@ift.uib.no
9 Comments, bug reports, suggestions welcome! 
10
11 Overview
12 ========
13 This package provides is a compilation of shared libraries of the ALICE
14 HLT project. 
15 - BASE: The base library (libHLTbase.so) provides the common interface for HLT 
16 processing components, the binding into the ALICE offline project AliRoot
17 and a pure C interface to the HLT on-line framework (Publisher/Subscriber
18 framework)
19 - SampleLib: The sample library contains examples for component 
20 implementation and a tutorial.
21 - TPCLib: The HLT code for the TPC
22
23 Setting up a version retrieved from CVS
24 =======================================
25 Skip this section if you have started from the tar ball.
26
27 A version checked out from CVS requires a few steps to set up the Makefiles
28 and to set some links which are related to the CVS structure at the IFT.
29 Go to the directory and run
30 autoreconf -i -f
31
32 Then continue with the package configuration described in the 'Installation'
33 section.
34
35 Modifying a distributed package
36 ===============================
37 If you are going the modify a distributed package you might need to re-make 
38 the GNU build system by running
39  autoreconf -f -i
40
41 Please notify the authors about bug fixes/corrections/extensions you made if
42 you consider them worth to be merged into the project.
43
44 Then continue with the package configuration described in the 'Installation'
45 section.
46
47 Installation
48 ============
49 Package build relies on the GNU triplet configure, make and make install.
50 It is suggested to use a separate build directory, e.g. from the
51 top directory do
52
53   mkdir build
54   cd build
55   ../configure
56   make
57   make install
58
59 The default install directories are set to the current directory ($PWD). Try
60
61 To override the default prefix use
62 --prefix=<dir>           
63
64 Some important options:
65 --enable-logging  # Enable/Disable logging (default enabled)
66 --enable-sample   # Compile the sample library
67 --enable-tpc      # Compile the TPC library
68
69 If you need further information on the GNU build system, execute from the 
70 top directory:
71 ./configure --help | less
72
73
74 Further information
75 ===================
76 A wiki with detailed information is set up at
77 http://www.kip.uni-heidelberg.de/wiki/HLT