Salome HOME
fix bug in pip major version comparison
[tools/sat.git] / src / internal_config / README_SRC.template
index af1d3d3ce61fc2573cffb0ac7703d713201c2aa9..014f63db4aad9e0a199e7aef161aa145baa9e0ee 100644 (file)
@@ -5,23 +5,22 @@ Sources
 This package includes the sources of the application. 
 They are located in the $ROOT/ARCHIVES directory.
 
-It also includes a version of SAlomeTools (sat), a suite of scripts to manage
+It also includes a version of sat, a suite of scripts to manage
 operations on your application (get sources, compilation, test, packaging ...).
 This version is configured to work with the application of the package.
 
 sat is located in $ROOT and you can read its documentation in 
-$ROOT/salomeTools/doc or by using:
-> $ROOT/sat --help
-> $ROOT/sat doc
+$ROOT/sat/doc or by using:
+> $ROOT/sat/sat --help
 
-If you use bash, you can have completion for sat by sourcing $ROOT/salomeTools/complete_sat.sh:
-> source $ROOT/salomeTools/complete_sat.sh
+If you use bash, you can have completion for sat by sourcing $ROOT/sat/complete_sat.sh:
+> source $ROOT/sat/complete_sat.sh
 
 
 a) Preparing the sources of your application
 ============================================
 Type the following command to get the source and apply the patches:
-> $ROOT/sat prepare ¤{application}
+> $ROOT/sat/sat prepare ¤{application}
 
 The sources are retrieved from tgz archives located in ARCHIVES directory (or from VCS tools 
 if they were included)
@@ -30,11 +29,16 @@ if they were included)
 b) Build ¤{application}
 =======================
 Type the following command to compile and install the products of your application:
-> $ROOT/sat -t compile ¤{application}
+> $ROOT/sat/sat -t compile ¤{application}
 
 The -t option displays the compilation logs in the terminal.
 
-IMPORTANT : 
+IMPORTANT 1:
+On CentOS 6.4 platform, the package devtoolset-2 must be installed to enable
+an alternative compiler and the compilation command must be preceded by
+"scl enable devtoolset-2".
+
+IMPORTANT 2: 
 This operation may fail if some required linux packages are not installed on your system.
 It is also often necessary to install a nvidia driver.
 If you fail to compile and your archive contains pre-compiled binaries, 
@@ -43,16 +47,18 @@ then you may be interested by a limited compilation based on the binaries used a
 In this case please refer to the instructions after 
 (paragraph compilation based on the binaries used as prerequisites).
 
+
 c) Set environment for libraries inside ¤{application}
 ======================================================
 Type the following command to produce the environment files:
-> $ROOT/sat environ ¤{application}
+> $ROOT/sat/sat environ ¤{application}
+
 
 d) Create a SALOME launcher
 ===========================
 
 Create the launcher:
-> $ROOT/sat launcher ¤{application}
+> $ROOT/sat/sat launcher ¤{application}
 
 IMPORTANT : 
 If your package already contains a binary installation 
@@ -64,11 +70,9 @@ of its launcher, called bin¤{launcher}
 e) How to set the Distene license
 =================================
 
-If your application is based on SALOME and embed the SMESH module and MeshGems 
+If your application is based on SALOME and use the SMESH module and MeshGems 
 prerequisite, you may want to set the Distene license. 
-To do so, edit the following file:
-
-> $ROOT/INSTALL/¤{profile}/bin/salome/¤{launcher}
+To do so, edit the salome  launcher file (its located in the $ROOT directory).
 
 Then, find the lines that begin with: