Salome HOME
Rollback products: qt -> 4.4.3, sip -> 4.7.7, PyQt -> 4.4.3, qwt -> 5.1.1, QScintilla...
[tools/install.git] / README
diff --git a/README b/README
index d6254fc15f64753767318518665ab4fb436aefa9..094ca893c58510a7fd5b493aeb59899e5f285903 100644 (file)
--- a/README
+++ b/README
            <parameter name="xterm"      value="no"/>
            <parameter name="portkill"   value="no"/>
            <parameter name="killall"    value="no"/>
-           <parameter name="modules"    value="GEOM,SMESH,VISU,SUPERV,MED,COMPONENT"/>
+           <parameter name="modules"    value="GEOM,SMESH,VISU,MED,YACS"/>
            <parameter name="embedded"   value="SalomeAppEngine"/>
            <parameter name="standalone" value="study,pyContainer,cppContainer,registry,moduleCatalog"/>
          </section>
                import salome_test
 
           When running, the script loads different modules (Geometry, Mesh, Med, 
-          Post-Pro and Supervisor) and tests various functionalities of these 
+          Post-Pro) and tests various functionalities of these 
           modules. You can watch the script execution progress in the embedded 
           python console window.
 
           products, required for the platform and SALOME modules sources.
           Then follow the scenario described below.
           In this scenario it is supposed that you have installed SALOME
-          modules sources in the /home/salome directory. The name of each module
+          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.
 
           * MED -> KERNEL, GUI
           * SMESH -> KERNEL, GUI, GEOM, MED
           * VISU -> KERNEL, GUI, MED
-          * SUPERV -> KERNEL, GUI
+          * YACS -> KERNEL, GUI
 
           SMESH plugins:
 
-          * NETGENPLUGIN -> KERNEL, GUI, SMESH
-          * GHS3DPLUGIN -> KERNEL, GUI, SMESH
-          * GHS3DPRLPLUGIN -> KERNEL, GUI, SMESH
-          * HexoticPLUGIN -> KERNEL, GUI, SMESH
-          * BLSURFPLUGIN -> KERNEL, GUI, SMESH
+          * NETGENPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH
+          * GHS3DPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH
+          * GHS3DPRLPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH
+          * HexoticPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH
+          * BLSURFPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH
 
           Sample modules:
 
           * PYCALCULATOR -> KERNEL, MED
           * CALCULATOR -> KERNEL, MED
           * HELLO -> KERNEL, GUI
-          * PYHELLO -> KERNEL
+          * PYHELLO -> KERNEL, GUI
          * LIGHT -> KERNEL, GUI
+         * PYLIGHT -> KERNEL, GUI
          * RANDOMIZER -> KERNEL, GUI
-         * SIERPINSKY -> KERNEL, GUI, VISU, RANDOMIZER
+         * SIERPINSKY -> KERNEL, GUI, MED, VISU, RANDOMIZER
 
           Note: SMESH plugins and sample modules are optional. You may skip 
           compiling them if you do not plan to use NETGEN and/or GHS3D meshing
           algorithms and do not want to build samples.
 
+          Note: Meshing plug-ins BLSURFPLUGIN, HexoticPLUGIN and
+          GHS3DPRLPLUGIN require commercial license for the Distene
+          meshers in runtime mode. Moreover, BLSURFPLUGIN requires
+          blsurf product at the compilation time. Without it, the
+          BLSURFPLUGIN meshing plugin compilation will fail. Refer
+         to http://www.distene.com/ for more details.
+
           In general, each module (except for KERNEL and GUI, of course) is 
           optional for SALOME. If you do not need a certain module, just do not 
           compile or install it. But remember that some modules require others 
 
           To build KERNEL module:
 
-          - go to installation root directory (/home/salome in this example):
+          - go to installation root directory (/home/user/salome in this example):
 
-               cd /home/salome
+               cd /home/user/salome
 
           - to set environment variables use bash or csh script, depending on 
             your shell:
           - run configure script which will check the environment and create 
            Makefile files:
 
-               ../KERNEL_SRC_5.1.2/configure --prefix=/home/salome/KERNEL_install
+               ../KERNEL_SRC_5.1.2/configure --prefix=/home/user/salome/KERNEL-5.1.2
 
           Note, that --prefix option defines the directory where you want to 
           install KERNEL module after 'make install' procedure. configure script
           You can learn more about the configure of any modules by using --help (-h) 
           parameter.
 
-          - build and (optionally) install KERNEL module:
+          - build and install KERNEL module:
 
                make
                make install
 
           After you have completed this scenario, KERNEL module is built and 
-          installed into /home/salome/KERNEL_install directory.
+          installed into /home/user/salome/KERNEL-5.1.2 directory.
 
           - modify your environment scripts:
 
           * for bash:
 
-               export KERNEL_ROOT_DIR=/home/salome/KERNEL_install
-            or 
-               export KERNEL_ROOT_DIR=/home/salome/KERNEL_build
-               (if make install step was not performed).
+               export KERNEL_ROOT_DIR=/home/user/salome/KERNEL-5.1.2
 
           * for csh:
 
-               setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install
-            or 
-               setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build
-               (if make install step was not performed).
+               setenv KERNEL_ROOT_DIR /home/user/salome/KERNEL-5.1.2
 
           - then repeat this scenario for other modules you want to build taking 
             into account the dependencies between modules (see dependencies table
 
           * for bash:
 
-               export MODULE_ROOT_DIR=/home/salome/<MODULE_distribution>
+               export MODULE_ROOT_DIR=/home/user/salome/<MODULE_distribution>
 
           * for csh:
 
-               setenv MODULE_ROOT_DIR /home/salome/<MODULE_distribution>
+               setenv MODULE_ROOT_DIR /home/user/salome/<MODULE_distribution>
 
-          where <MODULE_distribution> is a MODULE_build or MODULE_install (see above).
+          where <MODULE_distribution> is a MODULE-5.1.2 (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.