- adapted to AliRoot logging system, messages printed out via AliRoot
[u/mrichter/AliRoot.git] / HLT / README
index 8336e4f..8cc1ac1 100644 (file)
@@ -37,8 +37,9 @@ implementation and a tutorial.
 - TPCLib: The HLT code for the TPC
 - TPCLib/OnlineDisplay: HLT visualization code for the TPC
 
-Currently, the the package is not included to the standard AliRoot
-compilation, but will be part of it.
+- PHOS: The HLT code for PHOS
+
+- TRD: The HLT code for TRD
 
 The old stand-alone build system is still available. Check the README
 file in the doc folder.
@@ -90,23 +91,57 @@ Package build relies on the GNU triplet configure, make and make install.
 In order to keep the development directory clean, it is recommended to
 use a separate build directory. 
 
+It is recommended to read the complete section before the build process.
+
+5.1 For the impatiant user
+--------------------------
+
   mkdir build
   cd build
   ../configure
   make
   make install
 
-You should redirect the output of the make into a file.
-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=<dir>. More information
+can be obtained from the configure script by running it with option --help.
+All binary libraries will be installed under <prefix>/lib.
+
+If the directory is equal to $ALICE_ROOT, the libraries will be installed under 
+<prefix>/lib/tgt_<arch> as used for AliRoot. This is a custom extension in
+order to adapt to the specific AliRoot installation directories.
 
-To override the default prefix use
---prefix=<dir>           
+5.3 For the AliRoot user
+------------------------
+To install all libraries in the AliRoot lib dir:
 
-Some important options:
---enable-logging  # Enable/Disable logging (default enabled)
---enable-sample   # Compile the sample library
---enable-tpc      # Compile the TPC library
+  mkdir build
+  cd build
+  ../configure --prefix=$ALICE_ROOT
+  make
+  make install
 
+5.4 Package options
+-------------------
+Some important options (all options are on by default):
+--disable-sample           # disable compilation the sample library
+--disable-tpc              # disable compilation the TPC library
+--disable-phos             # disable compilation the PHOS library
+--disable-trd              # disable compilation the TRD library
+--disable-aliroot-logging  # disable logging
+
+5.5 External packages
+---------------------
+PubSub framework: the TPC online display needs the HOMER interface, which
+is currently part of the PubSub framework. It is planned to integrate it
+into AliRoot.
+If the TPC online display is not necessary one can skip this option.
+--with-pubsub=<dir>        # the top dir of the HLT PubSub framework
+
+5.6 Final remarks/further information 
+-------------------------------------
 Note: You can have several build directories with different configure options,
 but using the same source code. 
 
@@ -141,12 +176,17 @@ Please include the following information into your request:
 9. Committing to the AliRoot CVS
 ================================
 For development of HLT analysis code check out a HEAD version from the 
-repository and implement your code. For committing do:
-1. cvs update
-2. correct merging conflicts
-3. compile and test your code again
-4. send the whole HLT module except the build sub-directories to
+repository and implement your code. 
+
+For committing do:
+1. make sure that the code changes are correct
+   cvs diff | less
+   remember to restore all temporary changes you made (e.g. log level default)
+2. cvs update
+3. correct merging conflicts
+4. compile and test your code again
+5. send the whole HLT module except the build sub-directories to
    Matthias.Richter@ift.uib.no
-5. you will get a notification when the code is committed, right after that you
+6. you will get a notification when the code is committed, right after that you
    must either do another cvs update or check out the complete module again in
    order to have the right CVS information