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