README

   1 *******************
   2 About SALOME KERNEL
   3 *******************
   4
   5 SALOME KERNEL module implements general 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 software; 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 ------------------
  37 Basic Installation
  38 ------------------
  39
  40 The build procedure of the SALOME platform is implemented with CMake.
  41 In order to build the module you have to do the following actions:
  42
  43 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  44
  45 2. Create a build directory:
  46
  47    % mkdir KERNEL_BUILD
  48
  49 3. Configure the build procedure:
  50
  51    % cd KERNEL_BUILD
  52    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  53
  54    where
  55    - <mode> is either Release or Debug (default: Release);
  56    - <installation_directory> is a destination folder to install SALOME KERNEL
  57       module (default: /usr);
  58    - <path_to_src_dir> is a path to the SALOME KERNEL sources directory.
  59
  60    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME KERNEL
  61    module will be configured for installation to the /usr directory that requires
  62    root permissions to complete the installation.
  63
  64 4. Build and install:
  65
  66    % make
  67    % make install
  68
  69    This will install SALOME KERNEL module to the <installation_directory>
  70    specified to cmake command on the previous step.
  71
  72 -------------------
  73 Custom installation
  74 -------------------
  75
  76 SALOME KERNEL module supports a set of advanced configuration options;
  77 for more details learn CMakeLists.txt file in the root source directory.
  78
  79 You can also use other options of cmake command to customize your installation.
  80 Learn more about available options by typing
  81
  82    % cmake --help
  83
  84 =============
  85 Documentation
  86 =============
  87
  88 The directory doc contains additional documentation file of SALOME KERNEL module.
  89
  90 ===============
  91 Troubleshooting
  92 ===============
  93
  94 Please, send a mail to webmaster.salome@opencascade.com.