Salome HOME
Update for SALOME 2.2.6
[tools/install.git] / README
diff --git a/README b/README
index 6b6bdbe7ab3857a41634b9067fe2b747a99d5b26..89bf64e2c832d0ebe3b86f246c6af8c375f79996 100644 (file)
--- a/README
+++ b/README
      -f <xml-file>   
           The configuration file to be used by the Installation Wizard.  
           If this parameter is missed then the script tries to define 
-          the Red Hat version and uses corresponding xml file. 
-          For example, for the Red Hat 8.0 config_RedHat8_0.xml file 
-          is supposed to be used by default. If the appropriate file 
-          is not found, config.xml is used by default.
+          automatically the Linux platform and use the corresponding xml file
+          if there is one provided. 
+          For example, for Linux Red Hat 8.0 config_RedHat_8.0.xml file 
+          will be used by default. If the appropriate file  is not found,
+          default config.xml will be used. This file contains default
+          installation settings.
 
      -t <target-dir> 
           The target directory SALOME products to be installed to. 
        
           After you set environment you can start SALOME. Go to the KERNEL 
           module's binaries directory (KERNEL_2.2.0/bin/salome for the version 
-          2.2.0) by using of cd command and then type:
+          2.2.0) by using of 'cd' command and then type:
 
                runSalome [<parameters>]
 
-          This will start SALOME according to the configuration parameters which
-          are described into salome.launch file, located in your home directory
+          This will start SALOME according to the launching parameters which
+          are described in the salome.launch file, located in your home directory
           ( $HOME/.salome_<version-number>/salome.launch ),
           where <version_number> is number of SALOME version.
 
-          If this file does not exists, it is created on the first launch of 
-          SALOME from <KERNEL_ROOT_DIR>/bin/salome/salome.launch.
+          If this file does not exists, it is created automatically during the
+          first launch of SALOME by copying default file from <KERNEL_ROOT_DIR>/bin/salome
+          directory.
 
           You can modify SALOME launching options by editing 
           salome_<version_number>.launch file:
           </Configuration-list>     
 
           Each parameter described in salome.launch file can be overrided by 
-          using corresponding keys for runSalome script:
+          using corresponding command-line option for runSalome script:
 
           --gui
                 Launch GUI desktop
                 Start standalone container(s), possible values are registry, 
                 study, moduleCatalog, cppContainer, pyContainer, supervContainer
 
-          Note that there is no key which corresponds to the <plugin> tag.
+          Note that there is no command-line option which corresponds to the <plugin> tag.
           This tag can be used currently only for SMESH module to point external 
           meshers plugins which should be loaded by SMESH dynamically.
           Refer <SMESH_ROOT_DIR>/doc/salome/tui/SMESH/PluginMeshers.html
 
           When running, the script loads diferent modules (Geometry, Mesh, Med, 
           Post-Pro and Supervisor) and tests different functionality of these 
-          modules. You can watch script running progress in the python console
-          window.
+          modules. You can watch script running progress in the embedded python
+          console window.
 
 ================================================================================
 
 
      This section describes the way how to build SALOME modules manually from
      sources packages provided with Installation Wizard.
+
      4.1. General procedure
 
           If you want to build SALOME modules from sources, install all products
           necessary for the platform and SALOME modules sources.
           Then follow the scenario described below.
-          In the scenario below it is supposed that you have installed SALOME
+          In this scenario it is supposed that you have installed SALOME
           modules sources in the /home/salome directory. The name of each module
           sources directory depends on the version of the platform, for example,
           KERNEL_SRC_2.2.0 for KERNEL module of SALOME version 2.2.0.
           * SMESH -> KERNEL, GEOM, MED
           * VISU -> KERNEL, MED
           * SUPERV -> KERNEL
-          * COMPONENT -> KERNEL
-          * PYCALCULATOR -> KERNEL
+          * COMPONENT -> KERNEL, MED
+          * PYCALCULATOR -> KERNEL, MED
+          * CALCULATOR -> KERNEL, MED
           * NETGENPLUGIN -> KERNEL, SMESH
           * GHS3DPLUGIN -> KERNEL, SMESH
+          * HELLO -> KERNEL
+          * PYHELLO -> KERNEL
+
+          Note: mesher plugins (NETGENPLUGIN, GHS3DPLUGIN) are optional components. 
+          You may skip compiling them if you do not plan to use NETGEN and/or GHS3D
+          mesher algorithms.
+          The same concerns example components: CALCULATOR, PYCALCULATOR, COMPONENT,
+          HELLO, PYHELLO.
 
-          Note: NETGENPLUGIN, GHS3DPLUGIN are optional components. You may skip 
-          compiling them if you do not plan to use NETGEN and/or GHS3D mesher 
-          algorithms.
           In general, each module (except KERNEL, of course) is optional for 
           SALOME. If you do not need any module, just do not compile or install
           it. But remember that some modules require other ones to be built first 
             into account the dependancies between modules (see dependancies table
             above).
 
-          Note: if the compilation fails it may be caused by bad environment. 
-          In this case you should check that environment script you use 
-          (salome.csh or salome.sh) contains the following lines for each module:
-
-          * for bash:
-
-               export PATH=${<module>_ROOT_DIR}/bin/salome:${PATH}
-               export LD_LIBRARY_PATH=${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
-               export PYTHONPATH=${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
-               export PYTHONPATH=${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
-               export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
-               export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
-
-          * for csh:
-
-               setenv PATH ${<module>_ROOT_DIR}/bin/salome:${PATH}
-               setenv LD_LIBRARY_PATH ${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
-               setenv PYTHONPATH ${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
-               setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
-               setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
-               setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
+          Note: if the compilation fails it may be caused by bad environment.
+          Remember that you need to define <MODULE>_ROOT_DIR environment variable
+          for each module you use.
      
      4.2. Automatic build procedure: build.csh script
 
-          From version 2.2.0 SALOME Installation Wizard provides the script
+          From version 2.2.0 SALOME Installation Wizard includes the script
           for automatic building of SALOME modules from sources packages:
           build.csh. It is installed into the top-level target directory
           (the same directory where env_products.[c]sh files are generated.
 
           To use this script just install SALOME sources packages with
-          Installation Wizard, then cd to the SALOME isntallation directory
+          Installation Wizard, then cd to the SALOME installation directory
           and type:
 
                ./build.csh
 
-          and that's all.
-          
           By default, build.csh only compiles the modules but not installs them,
           i.e. does not perform 'make install' step.
           To do this, use -i option or -p <prefix> where <prefix> is target
 
           When you run build.csh at first time it is not necessary to pass 
           -b, -c parameters. The script detects if build procedure has not yet
-          been performed and runs build_configure, configure procedures
+          been performed and runs build_configure, configure scripts
           in this case.
 
           Note: for avoiding of collisions it is recommended not to install