README

   1 *********************
   2 About SALOME Geometry
   3 *********************
   4
   5 SALOME Geometry module implements the CAD modeling services:
   6 - Import and export of geometrical models in IGES, BREP, STEP, STL, XAO and VTK formats;
   7 - Construct geometrical objects using a wide range of functions;
   8 - Display geometrical objects in the 3D viewer;
   9 - Transform geometrical objects using various algorithms;
  10 - Repair geometrical objects (shape healing);
  11 - View information about geometrical objects using measurement tools;
  12 - Design shapes from pictures.
  13
  14 For more information please visit the SALOME platform web site:
  15
  16   <https://www.salome-platform.org/>
  17
  18 =======
  19 License
  20 =======
  21
  22 SALOME platform is distributed under the GNU Lesser General Public License.
  23 See COPYING file for more details.
  24
  25 ============
  26 Installation
  27 ============
  28
  29 --------------
  30 Pre-requisites
  31 --------------
  32
  33 SALOME platform relies on a set of third-party software; some of them are needed
  34 at build time only, while other ones are needed at runtime as well.
  35
  36 For more information about the pre-requisites please visit SALOME platform web
  37 site:
  38
  39 * Check Release Notes and Software Requirements of the latest SALOME release at
  40
  41   <https://www.salome-platform.org/?page_id=15/>
  42
  43 Note: SALOME Geometry module needs SALOME KERNEL and SALOME GUI as
  44 pre-requisites.
  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 GEOM_BUILD
  58
  59 3. Configure the build procedure:
  60
  61    % cd GEOM_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 Geometry
  67       module (default: /usr);
  68    - <path_to_src_dir> is a path to the SALOME Geometry sources directory.
  69
  70    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME Geometry
  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 Geometry module to the <installation_directory>
  80    specified to cmake command on the previous step.
  81
  82 -------------------
  83 Custom installation
  84 -------------------
  85
  86 SALOME Geometry 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 Geometry module.
  99
 100 ===============
 101 Troubleshooting
 102 ===============
 103
 104 Please, send a mail to webmaster.salome@opencascade.com.