README

   1 ****************
   2 About SALOME GUI
   3 ****************
   4
   5 SALOME GUI module implements general user interface services of SALOME platform.
   6
   7 For more information please visit the SALOME platform web site:
   8
   9   <http://www.salome-platform.org/>
  10
  11 =======
  12 License
  13 =======
  14
  15 SALOME platform is distributed under the GNU Lesser General Public License.
  16 See COPYING file for more details.
  17
  18 Also, additional information can be found at SALOME platform web site:
  19
  20   <http://www.salome-platform.org/downloads/license/>
  21
  22 ============
  23 Installation
  24 ============
  25
  26 --------------
  27 Pre-requisites
  28 --------------
  29
  30 SALOME platform relies on a set of third-party softwares; some of them are needed
  31 at build time only, while other ones are needed in runtime also.
  32
  33 For more information about the pre-requisites please visit SALOME platform web
  34 site:
  35
  36 * Check Release Notes and Software Requirements of the latest SALOME release at
  37
  38   <http://www.salome-platform.org/downloads/current-version/>
  39
  40 * Pre-requisites page at SALOME web site:
  41
  42   <http://www.salome-platform.org/downloads/license/>
  43
  44 Note: SALOME GUI module needs SALOME KERNEL as a pre-requisite.
  45
  46 ------------------
  47 Basic Installation
  48 ------------------
  49
  50 The build procedure of the SALOME platform is implemented with CMake.
  51 In order to build the module you have to do the following actions:
  52
  53 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  54
  55 2. Create a build directory:
  56
  57    % mkdir GUI_BUILD
  58
  59 3. Configure the build procedure:
  60
  61    % cd GUI_BUILD
  62    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  63
  64    where
  65    - <mode> is either Release or Debug (default: Release);
  66    - <installation_directory> is a destination folder to install SALOME GUI
  67       module (default: /usr);
  68    - <path_to_src_dir> is a path to the SALOME GUI sources directory.
  69
  70    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME GUI
  71    module will be configured for installation to the /usr directory that requires
  72    root permissions to complete the installation.
  73
  74 4. Build and install:
  75
  76    % make
  77    % make install
  78
  79    This will install SALOME GUI module to the <installation_directory>
  80    specified to cmake command on the previous step.
  81
  82 -------------------
  83 Custom installation
  84 -------------------
  85
  86 SALOME GUI module supports a set of advanced configuration options;
  87 for more details learn CMakeLists.txt file in the root source directory.
  88
  89 You can also use other options of cmake command to customize your installation.
  90 Learn more about available options by typing
  91
  92    % cmake --help
  93
  94 =============
  95 Documentation
  96 =============
  97
  98 The directory doc contains additional documentation file of SALOME GUI module.
  99
 100 ===============
 101 Troubleshooting
 102 ===============
 103
 104 Please, send a mail to webmaster.salome@opencascade.com.