INSTALL

   1 *************************
   2 Installation Instructions
   3 *************************
   4
   5 Copyright (C) 2014-2016 OPEN CASCADE
   6
   7 This library is free software; you can redistribute it and/or
   8 modify it under the terms of the GNU Lesser General Public
   9 License as published by the Free Software Foundation; either
  10 version 2.1 of the License, or (at your option) any later version.
  11
  12 This library is distributed in the hope that it will be useful
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 Lesser General Public License for more details.
  16
  17 You should have received a copy of the GNU Lesser General Public
  18 License along with this library; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20
  21 See http://www.salome-platform.org or email : webmaster.salome@opencascade.com
  22
  23 ==============
  24 Pre-requisites
  25 ==============
  26
  27 DXF plugin for SALOME Geometry module requires:
  28
  29 - SALOME, at least KERNEL and GEOM modules (http://www.salome-platform.org).
  30 - Open CASCADE Technology and OCCT DXF Import/Export XDE product
  31   (http://www.opencascade.org).
  32 - Other pre-requisite products, according to the SALOME pre-requisites list.
  33
  34 ==================
  35 Basic Installation
  36 ==================
  37
  38 The build procedure of the DXF plugin for SALOME Geometry module is
  39 created using CMake build system.
  40 In order to build the plugin you have to do the following actions:
  41
  42 1. Set an environment to point to the OCCT DXF XDE product, for example:
  43
  44    - for csh:
  45
  46    % setenv DXF_ROOT_DIR /path/to/the/DXF-6.9.0
  47    % setenv LD_LIBRARY_PATH ${DXF_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  48
  49    - for bash:
  50
  51    % export DXF_ROOT_DIR=/path/to/the/DXF-6.9.0
  52    % export LD_LIBRARY_PATH=${DXF_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  53
  54    Note, that OCCT DXF XDE product requires OCCT license library.
  55    Normally OCCT license library is distributed with OCCT DXF XDE
  56    product, but it can also be distributed separately. In latter
  57    case you might need to set-up environment to point to the OCCT
  58    license library, as follows:
  59
  60    - for csh:
  61
  62    % setenv OCCLICENSE_ROOT_DIR /path/to/the/OCCLicense-6.9.0
  63    % setenv LD_LIBRARY_PATH ${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  64
  65    - for bash:
  66
  67    % export OCCLICENSE_ROOT_DIR=/path/to/the/OCCLicense-6.9.0
  68    % export LD_LIBRARY_PATH=${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  69
  70 2. Create a build directory (in the example below, it is assumed
  71    that this directory is created at the same level as sources
  72    directory DXFPLUGIN_SRC), for example:
  73
  74    % mkdir DXFPLUGIN_BUILD
  75
  76 3. Configure the build procedure:
  77
  78    % cd DXFPLUGIN_BUILD
  79    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> ../DXFPLUGIN_SRC
  80
  81    where
  82    - <mode> is either Release or Debug;
  83    - <installation_directory> is a destination folder to install DXF plugin.
  84
  85    By default (if CMAKE_INSTALL_PREFIX option is not given), DXF plugin will be
  86    configured for installation to the /usr directory that requires root
  87    permissions to complete the installation.
  88
  89 4. Build and install DXF plugin:
  90
  91    % make
  92    % make install
  93
  94    This will install DXF plugin to the <installation_directory> specified
  95    with cmake command on previous step.
  96
  97 ===================
  98 Custom installation
  99 ===================
 100
 101 For setting unusual options for compilation or linking run the following
 102 commands o get details on some of the pertinent environment variables:
 103
 104    % cd DXFPLUGIN_BUILD
 105    % ccmake ../DXFPLUGIN_SRC
 106
 107 You can also use other options of cmake command to customize
 108 your installation. Learn more about available options by running
 109
 110    % cmake --help