corrected README
[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 and is intended for stand-alone compilation, i.e. not as part 
15 of the AliRoot compilation. 
16
17 - BASE: The base library (libHLTbase.so) provides the common interface for HLT 
18 processing components, the binding into the ALICE offline project AliRoot
19 and a pure C interface to the HLT on-line framework (Publisher/Subscriber
20 framework)
21
22 - SampleLib: The sample library contains examples for component 
23 implementation and a tutorial.
24
25 - TPCLib: The HLT code for the TPC
26
27 Currently, the the package is not included to the standard AliRoot
28 compilation, but will be part of it.
29
30 The old stand-alone build system is still available. Check the README
31 file in the doc folder.
32
33 Requirements
34 ============
35 The package needs both ROOT and AliRoot. Both must be set up in the
36 usual way (ROOTSYS, ALICE_ROOT, library locations evtl. specified in
37 LD_LIBRARY_PATH, ...). Actually, the BASE and SampleLib modules are
38 not dependend on AliRoot. The TPCLib does.
39
40 Setting up a version retrieved from CVS
41 =======================================
42 Skip this section if you have started from the tar ball.
43
44 A version checked out from CVS requires a few steps to set up the Makefiles
45 and to set some links which are related to the CVS structure at the IFT.
46 Go to the directory and run
47 autoreconf -i -f
48
49 Then continue with the package configuration described in the 'Installation'
50 section.
51
52 Modifying a distributed package
53 ===============================
54 If you are going the modify a distributed package you might need to re-make 
55 the GNU build system by running
56  autoreconf -f -i
57
58 Please notify the authors about bug fixes/corrections/extensions you made if
59 you consider them worth to be merged into the project.
60
61 Then continue with the package configuration described in the 'Installation'
62 section.
63
64 Installation
65 ============
66 NOTE: The Makefiles which are in repository are port of the old build system.
67 Now, the Makefile.am templates are valid.
68
69 Package build relies on the GNU triplet configure, make and make install.
70 For historical reasons there are Makefiles around from the old build system.
71 In order to avoid messing up the two build strategies, it is recommended to
72 use a separate build directory, e.g. from the top directory do
73
74   mkdir build
75   cd build
76   ../configure
77   make
78   make install
79
80 The default install directories are set to the current directory ($PWD).
81
82 To override the default prefix use
83 --prefix=<dir>           
84
85 Some important options:
86 --enable-logging  # Enable/Disable logging (default enabled)
87 --enable-sample   # Compile the sample library
88 --enable-tpc      # Compile the TPC library
89
90 Note: You can have several build directories with different configure options,
91 but using the same source code. 
92
93 If you need further information on the GNU build system, execute from the 
94 top directory:
95 ./configure --help | less
96
97
98 Documentation
99 =============
100 Documentation is generated from the source code at compile time if 
101 doxygen is installed on the machine. From the build directory, open
102 doc/html/index.html with a web browser.
103
104 Further information
105 ===================
106 A wiki with detailed information is set up at
107 http://www.kip.uni-heidelberg.de/wiki/HLT