doc/index.txt

   1
   2 =================================================================
   3 General information, for developpers and users
   4 =================================================================
   5
   6 .. contents::
   7 .. sectnum::
   8
   9
  10 *html version of this document is produced with docutils*::
  11
  12   rst2html < doc.txt > doc.html
  13
  14 This document corresponds to SALOME2 3.1. (alpha version)
  15
  16 +-------------------------------------------+
  17 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
  18 +-------------------------------------------+
  19
  20 Developpers and users, which documentation ?
  21 ============================================
  22
  23 Following your kind of usage of SALOME, you will find some specific
  24 introductory documentation, listed below.
  25
  26 Module maintainer
  27 -----------------
  28 Module maintainers are in charge of the development and debug of the SALOME
  29 modules. Each SALOME module is stored in a CVS base. CVS bases are organised
  30 in separate branches for developments and debug. All official or development
  31 releases are identified by a CVS tag.
  32
  33
  34 Application Integrator
  35 ----------------------
  36
  37 Applications integrators are in charge of configuration and installation of
  38 specific SALOME applications over a local network. Application Integrators
  39 built SALOME modules binaries from sources tarballs.
  40
  41 End user
  42 --------
  43
  44 The end user may have to configure his own SALOME applicatin by selection of a
  45 subset of availables SALOME modules. He also may want to install his
  46 application on several computers.
  47
  48
  49 Documentation for developpers and module maintainers
  50 ====================================================
  51
  52 Source code structuration and Unit Tests
  53 ----------------------------------------
  54
  55 See UnitTests_ for general information on code directories structure,
  56 unit tests associated to the different kind of classes, and how to run
  57 the unit tests.
  58
  59 .. _UnitTests: ./UnitTests.html
  60
  61 Documentation for application integrators and adminstrators
  62 ===========================================================
  63
  64 How to install SALOME
  65 ---------------------
  66
  67 See INSTALL_ for general information on required configuration and
  68 prerequisites, compilation procedure, setting environment principles.
  69
  70 .. _INSTALL: ./INSTALL.html
  71
  72 How to run SALOME on one or more computers, SALOME Application concept
  73 ----------------------------------------------------------------------
  74
  75 See SALOME_Application_ to define your own configuration of SALOME and run it
  76 on one or several computers. This is the recommended way of configuration.
  77
  78 .. _SALOME_Application: ./SALOME_Application.html
  79
  80
  81 End User documentation
  82 ======================
  83
  84 link to end user documentation.
  85
  86