Salome HOME
README update
[tools/simanio.git] / scripts / README
index 70a4f097ef2de15df74459de9e1a4bfe6c9450e3..4c786ab0b034d023adc255b92043e27c5b25c472 100644 (file)
@@ -1,6 +1,6 @@
 How to get and build SALOME-SIMAN code
 
-1. Take SALOME-SIMAN code from CVS repository for SIMAN 
+1. Take SALOME-SIMAN code from CVS repository for SIMAN.
 and the following modules "KERNEL GUI GEOM MED SMESH PYHELLO" like this
 
 cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/SIMAN checkout SIMANIO_SRC
@@ -10,6 +10,7 @@ cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/GEOM checkout -
 cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/MED checkout -r <branch name> MED_SRC
 cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/SMESH checkout -r <branch name> SMESH_SRC
 cvs -d :pserver:<user_name>@cvs.opencascade.com:/home/server/cvs/EXAMPLES checkout -r <branch name> PYHELLO1_SRC
+(rename the directory PYHELLO1_SRC to PYHELLO_SRC)
 
 where <branch name> is :
 "BR_siman_phase1" if you are based on SALOME 6.5.0
@@ -20,18 +21,29 @@ wso2-wsf-cpp-2.1.0_debian60-64.tgz
 wso2-wsf-cpp-2.1.0_mandriva_2010-64.tgz
 
 3. Copy the required scripts from SIMANIO_SRC/scripts directory to root directory (../..) and adjust them as necessary
+For Mandriva 2010-64 rename and use env_build_mandiva-2010-64.sh env_products_mandriva-2010-64.sh.
 This README files is also delivered in SIMANIO_SRC/scripts directory
 
 4. Build SIMANIO_SRC using these scripts as following :
-source env_siman.sh 
+. env_siman.sh 
 ./siman_build.sh
 
-5. Build all other modules in usual manner
+5. Then build other required SALOME modules in usual manner 
+for example, using the scripts provided with offical SALOME installation (env_build.sh, env_products.sh, build.sh)
 
-Note: additionally the following SALOME modules (not impacted with SIMAN changes) should be also build 
+Note :
+To build SALOME in the mode with SIMAN the SIMANIO_ROOT_DIR variable has to be defined and points to directory containing the include files and the preliminarily built SIMANIO library.
+It is used by configure in the conditional WITH_SIMANIO and CHECK_SIMANIO m4 check procedure.
+
+The setting the SIMANIO_ROOT_DIR variable is provided by executing (. env_siman.sh) on the previous step and it is enough to build properly SALOME KERNEL with SIMAN.
+
+It can be also achieved by usage of the configure option --with-simanio=$SIMANIO_ROOT_DIR.
+
+
+Additionally the following SALOME modules (not currently impacted with SIMAN changes) can be also built to using in SIMAN project test cases.
 "VISU PARAVIS YACS NETGENPLUGIN GHS3DPLUGIN BLSURFPLUGIN HexoticPLUGIN GHS3DPRLPLUGIN"
 
-6. Check runnability of SALOME in two modes - without and with SIMAN :
+6. Set SALOME runtime environment and Check runnability of SALOME in two modes - without and with SIMAN :
+. env_siman.sh
 runSalome
 runSalome --siman
-