Salome HOME
Update fro new products
[tools/install.git] / README
diff --git a/README b/README
index 0b3dd510c2daed3c8c61f8e4ea7de365e9c43107..fa1a5f1a9cbb43d52a322cdb7f2c0ea04a368e49 100644 (file)
--- a/README
+++ b/README
                source salome.csh
 
           where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g. 
-          KERNEL_5.1.2 for the 5.1.2 version.
+          KERNEL_5.1.3 for the 5.1.3 version.
 
      2.2. Launching of SALOME
        
           After you set environment you can start SALOME. Go to the KERNEL 
-          module's binaries directory (KERNEL_5.1.2/bin/salome for the version 
-          5.1.2) by using of 'cd' command and then type:
+          module's binaries directory (KERNEL_5.1.3/bin/salome for the version 
+          5.1.3) by using of 'cd' command and then type:
 
                runSalome [<parameters>]
 
           In this scenario it is supposed that you have installed SALOME
           modules sources in the /home/user/salome directory. The name of each module
           sources directory depends on the version of the platform, for example,
-          KERNEL_SRC_5.1.2 for KERNEL module of SALOME version 5.1.2.
+          KERNEL_SRC_5.1.3 for KERNEL module of SALOME version 5.1.3.
 
           Compilation and installation should be performed according to 
           the dependencies between modules:
 
           - create a configuration script by typing
 
-               ../KERNEL_SRC_5.1.2/build_configure
+               ../KERNEL_SRC_5.1.3/build_configure
 
           - run configure script which will check the environment and create 
            Makefile files:
 
-               ../KERNEL_SRC_5.1.2/configure --prefix=/home/user/salome/KERNEL-5.1.2
+               ../KERNEL_SRC_5.1.3/configure --prefix=/home/user/salome/KERNEL-5.1.3
 
           Note, that --prefix option defines the directory where you want to 
           install KERNEL module after 'make install' procedure. configure script
                make install
 
           After you have completed this scenario, KERNEL module is built and 
-          installed into /home/user/salome/KERNEL-5.1.2 directory.
+          installed into /home/user/salome/KERNEL-5.1.3 directory.
 
           - modify your environment scripts:
 
           * for bash:
 
-               export KERNEL_ROOT_DIR=/home/user/salome/KERNEL-5.1.2
+               export KERNEL_ROOT_DIR=/home/user/salome/KERNEL-5.1.3
 
           * for csh:
 
-               setenv KERNEL_ROOT_DIR /home/user/salome/KERNEL-5.1.2
+               setenv KERNEL_ROOT_DIR /home/user/salome/KERNEL-5.1.3
 
           - then repeat this scenario for other modules you want to build taking 
             into account the dependencies between modules (see dependencies table
 
                setenv MODULE_ROOT_DIR /home/user/salome/<MODULE_distribution>
 
-          where <MODULE_distribution> is a MODULE-5.1.2 (see above).
+          where <MODULE_distribution> is a MODULE-5.1.3 (see above).
 
      4.2. Automatic build procedure: build.csh and build.sh scripts
 
 
                ./build.csh
 
-          By default, build.csh only compiles the modules but does not install them,
-          i.e. does not perform 'make install' step.
-          To do this, use -i option or -p <prefix> where <prefix> is the
+          By default, build.csh builds and installs all SALOME
+          modules. All modules are installed to the INSTALL subfolder
+          of the current directory. If you need to change the installation
+          directory, you can use -p <prefix> option where <prefix> is the
           directory SALOME modules should be installed to.
 
-          If you want to build only some SALOME modules, just pass them as 
-          parameters, e.g.:
+          If you want to build only some subset of SALOME modules,
+          just pass them as parameters, e.g.:
 
-               ./build.csh -i KERNEL MED GEOM
+               ./build.csh -p /home/user/salome KERNEL MED GEOM
 
           The script also provides other options which specify compiling and 
           installation parameters. You can learn about these options by using
                ./build.csh -h
 
           When you run build.csh for the first time it is not necessary to pass 
-          -b, -c parameters. The script detects if build procedure has not yet
+          -b or -c parameters. The script detects if build procedure has not yet
           been performed and in this case runs build_configure, configure scripts
           automatically.
 
           Note: use -d option carefully because in this case the script removes
           the existing (previously installed) SALOME modules.
 
-          Note: please, take into your account that 'make install' step is
-          obligatory for the KERNEL module. Build directory of KERNEL
-          can not be indicated as KERNEL_ROOT_DIR. This is an exception
-          for the SALOME modules. So you should use either option -i
-          or -p of build.sch script when building KERNEL module.
-
           Note: build.(c)sh scripts do not modify the environment files
           (env_products.csh, etc). You should do it by yourself.