src/internal_config/README_SRC.template

   1 # This package was generated with sat ¤{version}
   2 # Date: ¤{date}
   3 # User: ¤{user}
   4 # Application: ¤{application}
   5
   6 Important
   7 =========
   8 The version of SAlomeTools included in this package is configured to work with
   9 the application of the package.
  10
  11 1) Introduction
  12 ===============
  13
  14 In the following, $ROOT represents the directory where you install your
  15 application (the directory where this file is located).
  16
  17 The sources of your application are located in the $ROOT/ARCHIVES directory.
  18
  19 This package includes SAlomeTools (sat) a suite of scripts to manage
  20 operations on your application (get sources, compilation, test, packaging ...).
  21
  22 sat is located in $ROOT and you can read its documentation in
  23 $ROOT/salomeTools/doc or by using:
  24 > $ROOT/sat --help
  25 > $ROOT/sat doc
  26
  27 If you use bash, you can have completion for sat by sourcing $ROOT/salomeTools/complete_sat.sh:
  28 > source $ROOT/salomeTools/complete_sat.sh
  29
  30 2) Preparing the sources of your application
  31 ============================================
  32 Tap the following command to get the source and apply the patches:
  33 > $ROOT/sat prepare ¤{application}
  34
  35 3) Build ¤{application}
  36 =======================
  37 Tap the following command to compile and install the products of your application:
  38 > $ROOT/sat compile ¤{application}
  39
  40 3) Set environment for libraries inside ¤{application}
  41 ======================================================
  42 Tap the following command to produce the environment files:
  43 > $ROOT/sat environ ¤{application}
  44
  45 4) Create a SALOME launcher
  46 ===========================
  47
  48 Create the launcher:
  49 > $ROOT/sat launcher ¤{application}
  50
  51 5) How to set the Distene license
  52 =================================
  53
  54 If your application is based on SALOME and embed the SMESH module and MeshGems
  55 prerequisite, you may want to set the Distene license.
  56 To do so, edit the following file:
  57
  58 > $ROOT/INSTALL/¤{profile}/bin/salome/¤{launcher}
  59
  60 Then, find the lines that begin with:
  61
  62     #[MeshGems]
  63     # Here you can define your license parameters for MeshGems
  64
  65 Set the variables corresponding to your licence after these lines.