README

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