README.FIRST.txt

   1
   2 =================================================================
   3 General information, for developpers and users
   4 =================================================================
   5 *html version of this document is produced with docutils*::
   6
   7   rest2html < doc.txt > doc.html
   8
   9 This document corresponds to SALOME2 3.1. (alpha version)
  10
  11 +-------------------------------------------+
  12 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
  13 +-------------------------------------------+
  14
  15 How to install SALOME
  16 ---------------------
  17
  18 See INSTALL_ for general information on required configuration and
  19 prerequisites, compilation procedure, setting environment principles.
  20
  21 .. _INSTALL: ./doc/INSTALL.html
  22
  23 How to run SALOME on one or more computers, SALOME Application concept
  24 ----------------------------------------------------------------------
  25
  26 See SALOME_Application_ to define your own configuration of SALOME and run it
  27 on one or several computers. This is the recommended way of configuration.
  28
  29 .. _SALOME_Application: ./doc/SALOME_Application.html
  30
  31
  32 Source code structuration and Unit Tests
  33 ----------------------------------------
  34
  35 See UnitTests_ for general information on code directories structure,
  36 unit tests associated to the different kind of classes, and how to run
  37 the unit tests.
  38
  39 .. _UnitTests: ./doc/UnitTests.html
  40
  41 End User documentation
  42 ----------------------
  43
  44 link to end user documentation.
  45
  46
  47 Developper documentation
  48 ------------------------
  49
  50 How to generate the developper documentation.