README.FIRST.txt

   1 Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2
   3 Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5
   6 This library is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU Lesser General Public
   8 License as published by the Free Software Foundation; either
   9 version 2.1 of the License.
  10
  11 This library is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public
  17 License along with this library; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22 =================================================================
  23 General information, for developpers and users
  24 =================================================================
  25 *html version of this document is produced with docutils*::
  26
  27   rest2html < doc.txt > doc.html
  28
  29 This document corresponds to SALOME2 3.1. (alpha version)
  30
  31 +-------------------------------------------+
  32 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
  33 +-------------------------------------------+
  34
  35 How to install SALOME
  36 ---------------------
  37
  38 See INSTALL_ for general information on required configuration and
  39 prerequisites, compilation procedure, setting environment principles.
  40
  41 .. _INSTALL: ./doc/INSTALL.html
  42
  43 How to run SALOME on one or more computers, SALOME Application concept
  44 ----------------------------------------------------------------------
  45
  46 See SALOME_Application_ to define your own configuration of SALOME and run it
  47 on one or several computers. This is the recommended way of configuration.
  48
  49 .. _SALOME_Application: ./doc/SALOME_Application.html
  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: ./doc/UnitTests.html
  60
  61 End User documentation
  62 ----------------------
  63
  64 link to end user documentation.
  65
  66
  67 Developper documentation
  68 ------------------------
  69
  70 How to generate the developper documentation.