*************************
Installation Instructions
*************************

Copyright (C) 2014-2016 OPEN CASCADE

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either 
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful 
but WITHOUT ANY WARRANTY; without even the implied warranty of 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public  
License along with this library; if not, write to the Free Software 
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA

See http://www.salome-platform.org or email : webmaster.salome@opencascade.com

==============
Pre-requisites
==============

OCCT Canonical recognition (CANREC) plugin for SALOME Geometry module requires:

- SALOME, at least KERNEL and GEOM modules (http://www.salome-platform.org).
- Open CASCADE Technology and OCCT Canonical recognition (CR) product
  (http://www.opencascade.org).
- Other pre-requisite products, according to the SALOME pre-requisites list.

==================
Basic Installation
==================

The build procedure of the CANREC plugin for SALOME Geometry module is
created using CMake build system.
In order to build the plugin you have to do the following actions: 

1. Set an environment to point to the OCCT Canonical recognition product,
for example:

   - for csh:

   % setenv CR_ROOT_DIR /path/to/the/CR-6.9.0
   % setenv LD_LIBRARY_PATH ${CR_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   - for bash:
   
   % export CR_ROOT_DIR=/path/to/the/CR-6.9.0
   % export LD_LIBRARY_PATH=${CR_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   Note, that OCCT CR product requires OCCT license library.
   Normally OCCT license library is distributed with OCCT CR
   product, but it can also be distributed separately. In latter
   case you might need to set-up environment to point to the OCCT
   license library, as follows:

   - for csh:

   % setenv OCCLICENSE_ROOT_DIR /path/to/the/OCCLicense-6.9.0
   % setenv LD_LIBRARY_PATH ${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   - for bash:
   
   % export OCCLICENSE_ROOT_DIR=/path/to/the/OCCLicense-6.9.0
   % export LD_LIBRARY_PATH=${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

2. Create a build directory (in the example below, it is assumed
   that this directory is created at the same level as sources
   directory CANRECPLUGIN_SRC), for example:

   % mkdir CANRECPLUGIN_BUILD

3. Configure the build procedure:

   % cd CANRECPLUGIN_BUILD
   % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> ../CANRECPLUGIN_SRC

   where
   - <mode> is either Release or Debug;
   - <installation_directory> is a destination folder to install CANREC plugin.

   By default (if CMAKE_INSTALL_PREFIX option is not given), CANREC plugin will be
   configured for installation to the /usr directory that requires root 
   permissions to complete the installation.

4. Build and install CANREC plugin:

   % make
   % make install

   This will install CANREC plugin to the <installation_directory> specified
   with cmake command on previous step.

===================
Custom installation
===================

For setting unusual options for compilation or linking run the following
commands o get details on some of the pertinent environment variables:

   % cd CANRECPLUGIN_BUILD
   % ccmake ../CANRECPLUGIN_SRC 

You can also use other options of cmake command to customize
your installation. Learn more about available options by running

   % cmake --help