README

   1 *************************
   2 About SALOME HELLO sample
   3 *************************
   4
   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.
   8
   9 For more information about SALOME platform please visit the SALOME web site:
  10
  11   <http://www.salome-platform.org/>
  12
  13 =======
  14 License
  15 =======
  16
  17 SALOME platform is distributed under the GNU Lesser General Public License.
  18 See COPYING file for more details.
  19
  20 Also, additional information can be found at SALOME platform web site:
  21
  22   <http://www.salome-platform.org/downloads/license/>
  23
  24 ============
  25 Installation
  26 ============
  27
  28 --------------
  29 Pre-requisites
  30 --------------
  31
  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.
  34
  35 For more information about the pre-requisites please visit SALOME platform web
  36 site:
  37
  38 * Check Release Notes and Software Requirements of the latest SALOME release at
  39
  40   <http://www.salome-platform.org/downloads/current-version/>
  41
  42 * Pre-requisites page at SALOME web site:
  43
  44   <http://www.salome-platform.org/downloads/license/>
  45
  46 Note: SALOME HELLO needs SALOME KERNEL and SALOME GUI as pre-requisites.
  47
  48 ------------------
  49 Basic Installation
  50 ------------------
  51
  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:
  54
  55 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  56
  57 2. Create a build directory:
  58
  59    % mkdir HELLO_BUILD
  60
  61 3. Configure the build procedure:
  62
  63    % cd HELLO_BUILD
  64    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  65
  66    where
  67    - <mode> is either Release or Debug (default: Release);
  68    - <installation_directory> is a destination folder to install SALOME HELLO
  69      module (default: /usr);
  70    - <path_to_src_dir> is a path to the SALOME HELLO sources directory.
  71
  72    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME HELLO
  73    module will be configured for installation to the /usr directory that requires
  74    root permissions to complete the installation.
  75
  76 4. Build and install:
  77
  78    % make
  79    % make install
  80
  81    This will install SALOME HELLO module to the <installation_directory>
  82    specified to cmake command on the previous step.
  83
  84 -------------------
  85 Custom installation
  86 -------------------
  87
  88 SALOME HELLO module supports a set of advanced configuration options;
  89 for more details learn CMakeLists.txt file in the root source directory.
  90
  91 You can also use other options of cmake command to customize your installation.
  92 Learn more about available options by typing
  93
  94    % cmake --help
  95
  96 ===============
  97 Troubleshooting
  98 ===============
  99
 100 Please, send a mail to webmaster.salome@opencascade.com.