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