Salome HOME
*** empty log message ***
[tools/install.git] / README
diff --git a/README b/README
index 04b76dac90ce9e0fa9c3d0f78b4f6dba1fa1a282..7a04652fcdb76ab9efc2c082fd26a4efeffe53c9 100644 (file)
--- a/README
+++ b/README
      option overrides the default temporary directory, given in the
      configuration xml file (usually /tmp, see here for more detail). 
 
+     -a / --all-from-sources
+
+     Force all products to be installed from sources including SALOME
+     modules.If this option is used all the default installation modes
+     are ignored.
+
      -h / --help
 
      Prints help information about available options.
                source salome.csh
 
           where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g. 
-          KERNEL_3.2.3 for the 3.2.3 version.
+          KERNEL_3.2.6 for the 3.2.6 version.
 
      2.2. Launching of SALOME
        
           After you set environment you can start SALOME. Go to the KERNEL 
-          module's binaries directory (KERNEL_3.2.3/bin/salome for the version 
-          3.2.3) by using of 'cd' command and then type:
+          module's binaries directory (KERNEL_3.2.6/bin/salome for the version 
+          3.2.6) by using of 'cd' command and then type:
 
                runSalome [<parameters>]
 
           This will start SALOME according to the launching parameters which
           are described in the configuration files: SalomeApp.xml in the 
-          <GUI_ROOT_DIR>/share/salome/resources folder and .SalomeApprc.<version_number>
-          file, located in your home directory (where <version_number> is number 
-          of SALOME version). If the latest file does not exist, it is automatically
-         created during the first launch of SALOME.
+          <GUI_ROOT_DIR>/share/salome/resources/gui folder and 
+          .SalomeApprc.<version_number> file, located in your home
+          directory (where <version_number> is SALOME version number).
+          If the user configuration file does not exist, it is automatically
+          created when exiting SALOME GUI.
 
           You can modify SALOME launching options by editing your 
-          ~/.SalomeApprc.<version_number> file:
+          ~/.SalomeApprc.<version_number> file (not all the options are
+          listed below):
 
           <section name="launch">
            <parameter name="gui"        value="yes"/>
                - from binaries: ~10 minutes;
                - from sources: more than 24 hours.
 
-         Note, the most time-consuming process is compiling of CASCADE libraries from
-         sources - it takes about 90% of time needed for compilation of all products.
-        
      3.2. Log files
 
           The Installation Wizard displays the installation progress in the 
           modules. You can watch script running progress in the embedded 
           python console window.
 
+          Note: the salome_test.py scripts require SALOME samples
+          module (SAMPLES_SRC) to be installed (this module includes set of sample
+          MED, Python, Supervisor graph, etc files).
+          Environment variable DATA_DIR should point to the SALOME
+          samples module directory.
+
 ================================================================================
 
   4. How to build SALOME modules from sources
           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_3.2.3 for KERNEL module of SALOME version 3.2.3.
+          KERNEL_SRC_3.2.6 for KERNEL module of SALOME version 3.2.6.
 
           The order of compilation and installation should be performed according 
           to the dependancies between modules:
 
           - create a configuration script by typing
 
-               ../KERNEL_SRC_3.2.3/build_configure
+               ../KERNEL_SRC_3.2.6/build_configure
 
           - run configure script which will check the environment and create 
            Makefile files:
 
-               ../KERNEL_SRC_3.2.3/configure --prefix=/home/salome/KERNEL_install
+               ../KERNEL_SRC_3.2.6/configure --prefix=/home/salome/KERNEL_install
 
           Note, that --prefix option defines the directory where you want to 
           install KERNEL module after 'make install' procedure. configure script
 
           where <MODULE_distribution> is a MODULE_build or MODULE_install (see above).
 
-     4.2. Automatic build procedure: build.csh script
+     4.2. Automatic build procedure: build.csh and build.sh scripts
 
-          From version 2.2.0 SALOME Installation Wizard includes the script
+          SALOME Installation Wizard includes two scripts which can be used
           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.
+          build.csh and build.sh. The scripts are installed into the top-level
+          installation directory (the same directory where env_products.[c]sh
+          files are generated).
+
+          The build.csh and buils.sh scripts implement the same functionality
+          and support the same set of options, but for different shells.
+          Use build.csh script for csh and build.sh for bash.
+          The description below refers to both scripts.
 
-          To use this script just install SALOME sources packages with
+          To use the script just install SALOME sources packages with the
           Installation Wizard, then cd to the SALOME installation directory
           and type:
 
 
           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 target
-          directory.
+          To do this, use -i option or -p <prefix> 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.:
           for the SALOME modules. So you should use one of options -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.
+
 ================================================================================