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