1 *************************
2 About SALOME HELLO sample
3 *************************
5 SALOME HELLO module presents example of a simple SALOME module, implemented
6 with C++. This sample demonstrates a way to create a modules which provide
7 services via the CORBA engine.
9 For more information about SALOME platform please visit the SALOME web site:
11 <https://www.salome-platform.org/>
17 SALOME platform is distributed under the GNU Lesser General Public License.
18 See COPYING file for more details.
28 SALOME platform relies on a set of third-party softwares; some of them are needed
29 at build time only, while other ones are needed in runtime also.
31 For more information about the pre-requisites please visit SALOME platform web
34 * Check Release Notes and Software Requirements of the latest SALOME release at
36 <https://www.salome-platform.org/?page_id=15/>
38 Note: SALOME HELLO needs SALOME KERNEL and SALOME GUI as pre-requisites.
44 The build procedure of the SALOME platform is implemented with CMake.
45 In order to build the module you have to do the following actions:
47 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
49 2. Create a build directory:
53 3. Configure the build procedure:
56 % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
59 - <mode> is either Release or Debug (default: Release);
60 - <installation_directory> is a destination folder to install SALOME HELLO
61 module (default: /usr);
62 - <path_to_src_dir> is a path to the SALOME HELLO sources directory.
64 Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME HELLO
65 module will be configured for installation to the /usr directory that requires
66 root permissions to complete the installation.
73 This will install SALOME HELLO module to the <installation_directory>
74 specified to cmake command on the previous step.
80 SALOME HELLO module supports a set of advanced configuration options;
81 for more details learn CMakeLists.txt file in the root source directory.
83 You can also use other options of cmake command to customize your installation.
84 Learn more about available options by typing
92 Please, send a mail to webmaster.salome@opencascade.com.