1 *****************************
2 About SALOME COMPONENT sample
3 *****************************
5 COMPONENT module implements a sample of SALOME component.
6 It shows how to introduce new functionalities into SALOME platform
7 by implementing custom CORBA-based component engine.
9 For more information please visit the SALOME platform web site:
11 <http://www.salome-platform.org/>
17 SALOME platform is distributed under the GNU Lesser General Public License.
18 See COPYING file for more details.
20 Also, additional information can be found at SALOME platform web site:
22 <http://www.salome-platform.org/downloads/license/>
32 SALOME platform relies on a set of third-party softwares; some of them are needed
33 at build time only, while other ones are needed in runtime also.
35 For more information about the pre-requisites please visit SALOME platform web
38 * Check Release Notes and Software Requirements of the latest SALOME release at
40 <http://www.salome-platform.org/downloads/current-version/>
42 * Pre-requisites page at SALOME web site:
44 <http://www.salome-platform.org/downloads/license/>
46 Note: SALOME COMPONENT needs SALOME KERNEL as a pre-requisite.
52 The build procedure of the SALOME platform is implemented with CMake.
53 In order to build the module you have to do the following actions:
55 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
57 2. Create a build directory:
59 % mkdir COMPONENT_BUILD
61 3. Configure the build procedure:
64 % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
67 - <mode> is either Release or Debug (default: Release);
68 - <installation_directory> is a destination folder to install SALOME COMPONENT
69 module (default: /usr);
70 - <path_to_src_dir> is a path to the SALOME COMPONENT sources directory.
72 Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME COMPONENT
73 module will be configured for installation to the /usr directory that requires
74 root permissions to complete the installation.
81 This will install SALOME COMPONENT module to the <installation_directory>
82 specified to cmake command on the previous step.
88 SALOME COMPONENT module supports a set of advanced configuration options;
89 for more details learn CMakeLists.txt file in the root source directory.
91 You can also use other options of cmake command to customize your installation.
92 Learn more about available options by typing
100 The directory doc contains additional documentation file of SALOME COMPONENT module.
106 Please, send a mail to webmaster.salome@opencascade.com.