X-Git-Url: http://git.uio.no/git/?a=blobdiff_plain;f=HLT%2FREADME;h=8af0689180a0006b3f6d98f342b64a15dab1e936;hb=0fd6e4c33db94b849446e7ded6352d98b68657b1;hp=1c925e1849a6038095df539f57b62d0e7fbaa7f1;hpb=78b557c2e7315319e6c2af7f666728eb4e008675;p=u%2Fmrichter%2FAliRoot.git diff --git a/HLT/README b/HLT/README index 1c925e1849a..8af0689180a 100644 --- a/HLT/README +++ b/HLT/README @@ -1,6 +1,9 @@ Package: ALICE HLT -This package implements the ALICE High Level Trigger framework. +This package implements the ALICE High Level Trigger analysis framework +and analysis component libraries. All files are property of and copyright +by the ALICE HLT Project unless stated differently. + All contributions are under the terms of the GNU General Public License as published by the Free Software Foundation. Also see files AUTHORS and THANKS. @@ -8,36 +11,51 @@ Foundation. Also see files AUTHORS and THANKS. This packages is maintained by Matthias.Richter@ift.uib.no Comments, bug reports, suggestions welcome! -Overview -======== -This package provides is a compilation of shared libraries of the ALICE +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ++ TOC +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ++ 1. Overview ++ 2. Requirements ++ 3. Setting up a version retrieved from SVN ++ 4. Modifying a distributed package ++ 5. Installation ++ 6. Documentation ++ 7. Further information ++ 8. Reporting bugs/Asking for support ++ 9. Committing to the AliRoot SVN +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +1. Overview +=========== +This package provides a compilation of shared libraries of the ALICE HLT project and is intended for stand-alone compilation, i.e. not as part of the AliRoot compilation. -- BASE: The base library (libHLTbase.so) provides the common interface for HLT -processing components, the binding into the ALICE offline project AliRoot -and a pure C interface to the HLT on-line framework (Publisher/Subscriber -framework) + - \b BASE: The base library (libHLTbase.so) provides the common interface for + HLT processing components, the binding into the ALICE offline project + AliRoot and a pure C interface to the HLT on-line framework + (Publisher/Subscriber framework) + + - \b SampleLib: The sample library contains examples for component + implementation and a tutorial. -- SampleLib: The sample library contains examples for component -implementation and a tutorial. + - \b TPCLib: The HLT code for the TPC + - \b TPCLib/OnlineDisplay: HLT visualization code for the TPC -- TPCLib: The HLT code for the TPC + - \b PHOS: The HLT code for PHOS -Currently, the the package is not included to the standard AliRoot -compilation, but will be part of it. + - \b TRD: The HLT code for TRD -The old stand-alone build system is still available. Check the README -file in the doc folder. + - \b MUON: The HLT code for MUON -Requirements -============ +2. Requirements +=============== The package needs both ROOT and AliRoot. Both must be set up in the usual way (ROOTSYS, ALICE_ROOT, library locations evtl. specified in LD_LIBRARY_PATH, ...). Actually, the BASE and SampleLib modules are not dependend on AliRoot. The TPCLib does. -To set up a version retrieved from CVS, autoconf 2.57, automake 1.6 +To set up a version retrieved from SVN, autoconf 2.57, automake 1.6 ,and libtool 1.4 or higher versions are required. Thats the versions which come with the Scientific Linux CERN 3. The same applies if you want to change the Makefiles. @@ -45,23 +63,24 @@ you want to change the Makefiles. If your GNU build tools are too old, ask the maintainers for a distributed package. -Setting up a version retrieved from CVS -======================================= +3. Setting up a version retrieved from SVN +========================================== Skip this section if you have started from the tar ball. -A version checked out from CVS requires a few steps to set up the Makefiles -and to set some links which are related to the CVS structure at the IFT. +A version checked out from SVN requires a few steps to set up the Makefiles. Go to the directory and run -autoreconf -i -f + + autoreconf -i -f Then continue with the package configuration described in the 'Installation' section. -Modifying a distributed package -=============================== +4. Modifying a distributed package +================================== If you are going the modify a distributed package you might need to re-make the GNU build system by running - autoreconf -f -i + + autoreconf -f -i Please notify the authors about bug fixes/corrections/extensions you made if you consider them worth to be merged into the project. @@ -69,15 +88,19 @@ you consider them worth to be merged into the project. Then continue with the package configuration described in the 'Installation' section. -Installation -============ -NOTE: The Makefiles which are in repository are port of the old build system. -Now, the Makefile.am templates are valid. - +5. Installation +=============== Package build relies on the GNU triplet configure, make and make install. -For historical reasons there are Makefiles around from the old build system. -In order to avoid messing up the two build strategies, it is recommended to -use a separate build directory, e.g. from the top directory do +In order to keep the development directory clean, it is recommended to +use a separate build directory. + +\b NOTE: Autotools creates the Makefiles from templates. All \b changes have to +be done to the \b Makefile.am templates. + +It is recommended to read the complete section before the build process. + +5.1 For the impatiant user +-------------------------- mkdir build cd build @@ -85,31 +108,138 @@ use a separate build directory, e.g. from the top directory do make make install -The default install directories are set to the current directory ($PWD). +5.2 Installation directory +-------------------------- +The default install directory is set to the current directory ($PWD). To +override the default directory use the option + --prefix=