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

Copyright (C) 2014-2015 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
==============

ACIS plugin for SALOME Geometry module requires:

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

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

The build procedure of the ACIS 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 ACIS/SAT XDE product, for example:

   - for csh:

   % setenv ACIS_ROOT_DIR /path/to/the/ACIS-6.9.0
   % setenv LD_LIBRARY_PATH ${ACIS_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

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

   Note, that OCCT ACIS/SAT XDE product requires OCCT license library.
   Normally OCCT license library is distributed with OCCT ACIS/SAT XDE
   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 ACISPLUGIN_SRC), for example:

   % mkdir ACISPLUGIN_BUILD

3. Configure the build procedure:

   % cd ACISPLUGIN_BUILD
   % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> ../ACISPLUGIN_SRC

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

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

4. Build and install ACIS plugin:

   % make
   % make install

   This will install ACIS 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 ACISPLUGIN_BUILD
   % ccmake ../ACISPLUGIN_SRC 

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

   % cmake --help