Extra header added to the list
[u/mrichter/AliRoot.git] / INSTALL.txt
index 70e47ce..3a6650c 100644 (file)
@@ -23,6 +23,9 @@ In order to build and install AliRoot 3 folders need to be defined.
  all intermediary files and generated build files
  3. Installation folder - The folder when AliRoot libraries and binaries will be installed.
 
+Minimum version of CMake for AliRoot is 2.8.11, but we recommend to stay up to date with
+the latest stable version.
+
 Important Note: All these 3 folders have to be in different locations.
 Important Note: Developers information below
 
@@ -66,7 +69,7 @@ for the generation of DAs (full documentation HERE -> link to daq documentation)
     The full list of AliRoot configuration parameters
     - CMAKE_INSTALL_PREFIX - mandatory standard CMake paramenter. It points to AliRoot installation directory.
     - ROOTSYS - mandatory Root installation directory.
-    - ALIEN - AliEn2 installation directory. This configuration parameter is mandatory if Root was build with 
+    - ALIEN - AliEn2 root installation directory. This configuration parameter is mandatory if Root was build with 
               AliEn2 support
     - FASTJET - FastJet installation point
     - ZEROMQ - ZeroMQ custom installation point. Not needed if ZeroMQ is installed on the system.
@@ -74,6 +77,7 @@ for the generation of DAs (full documentation HERE -> link to daq documentation)
     - ODIR - Platform for DIM, usually "linux"
     - SHUTTLE - default value OFF. To enable Shuttle build it needs to be set to ON
     - DATE_CONFIG - full location for date-config
+                   Do not forget to source setup.sh before running AliRoot cmake
     - AMORE_CONFIG - full location for amore-config
     - DA - default value OFF. To enable the build of DAs set it to ON
     - daqDA - location of daqDA libraries
@@ -94,6 +98,14 @@ for the generation of DAs (full documentation HERE -> link to daq documentation)
     If we need to change any configuration paramenter, for example the Root installation point set by ROOTSYS it
     is mandatory to delete the $MY_WORK_DIR/build/CMakeCache.txt file and rerun the full "cmake" command
     
+    CMake offers general configuration options that can be set using CMAKE_BUILD_TYPE.
+    Possible values are empty, Debug, Release, RelWithDebInfo and MinSizeRel. This variable is only supported for
+    make based generators. If this variable is supported, then CMake will also provide initial values for the variables
+    with the name CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. For example, if CMAKE_BUILD_TYPE is Debug,
+    then CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.
+    
+    CMAKE_BUILD_TYPE for AliRoot Grid packages is RelWithDebInfo.
+    
 5. Build AliRoot
     After the configuration is done the build can be started. Inside the build directory we type
     $ make
@@ -106,6 +118,14 @@ for the generation of DAs (full documentation HERE -> link to daq documentation)
     or
     $ make -j16 VERBOSE=1 # verbose mode enabled only for this make command
     
+    Running "make" inside the root of the build directory will trigger the build of the full AliRoot.
+    Building per folder is possible. Just switch to the folder in question and run "make". This will
+    trigger the build of the current folder plus all its dependencies.
+    
+    Example:
+    $ cd PWGJE/EMCALJetTasks
+    $ make -j16
+    
 6. Install AliRoot
     If the build finished successfuly than AliRoot can be properly installed inside "install" folder
     Inside the build folder run: