*****************************
About SALOME COMPONENT sample
*****************************

COMPONENT module implements a sample of SALOME component.
It shows how to introduce new functionalities into SALOME platform
by implementing custom CORBA-based component engine.

For more information please visit the SALOME platform web site:

  <https://www.salome-platform.org/>

=======
License
=======

SALOME platform is distributed under the GNU Lesser General Public License.
See COPYING file for more details.

============
Installation
============

--------------
Pre-requisites
--------------

SALOME platform relies on a set of third-party softwares; some of them are needed
at build time only, while other ones are needed in runtime also.

For more information about the pre-requisites please visit SALOME platform web
site:

* Check Release Notes and Software Requirements of the latest SALOME release at

  <https://github.com/SalomePlatform/.github/wiki/SAT/>

Note: SALOME COMPONENT needs SALOME KERNEL as a pre-requisite.

------------------
Basic Installation
------------------

The build procedure of the SALOME platform is implemented with CMake.
In order to build the module you have to do the following actions: 

1. Set up environment for pre-requisites (see "Pre-requisites" section above).

2. Create a build directory:

   % mkdir COMPONENT_BUILD

3. Configure the build procedure:

   % cd COMPONENT_BUILD
   % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>

   where
   - <mode> is either Release or Debug (default: Release);
   - <installation_directory> is a destination folder to install SALOME COMPONENT
     module (default: /usr); 
   - <path_to_src_dir> is a path to the SALOME COMPONENT sources directory.

   Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME COMPONENT
   module will be configured for installation to the /usr directory that requires
   root permissions to complete the installation.

4. Build and install:

   % make
   % make install

   This will install SALOME COMPONENT module to the <installation_directory>
   specified to cmake command on the previous step.

-------------------
Custom installation
-------------------

SALOME COMPONENT module supports a set of advanced configuration options;
for more details learn CMakeLists.txt file in the root source directory.

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

   % cmake --help

===============
Troubleshooting
===============

Please, send a mail to webmaster.salome@opencascade.com.