X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fmain.dox;h=33458d1189e05c1707b1467112baafb100d0d924;hb=cca842065fd2bb93bae7ed6c32a7de16b06f94d9;hp=eea5b33e946dc0658174f982db18773f453d61f3;hpb=991804e5e6def86ec8f17019e3dab9f3785431ba;p=modules%2Fkernel.git diff --git a/doc/salome/main.dox b/doc/salome/main.dox index eea5b33e9..33458d118 100644 --- a/doc/salome/main.dox +++ b/doc/salome/main.dox @@ -4,20 +4,19 @@ \image html icon_about.png Welcome to the %SALOME KERNEL documentation ! -Following your kind of usage of %SALOME, you will find some specific +Following your kind of usage of %SALOME, you will find some specific introductory documentation, listed below. \section S2_main End user -# How to configure a %SALOME application\n - The end user may have to configure his own %SALOME application by selection of a - subset of availables %SALOME modules. He also may want to install his - application on several computers. - See \subpage SALOME_Application to define your own configuration of %SALOME and run it + The end user may have to configure his own %SALOME application by selecting a + subset of available %SALOME modules. He may also want to install his + application on several computers. + See \subpage SALOME_Application to define your own configuration of %SALOME and run it on one or several computers. This is the recommended way of configuration. --# How to launch %SALOME: - - In a %SALOME application, see \ref SALOME_Application. - - Using \c runSalome script, see \subpage running_salome_page +-# How to launch %SALOME\n + Use the python \subpage salome_command. -# How to use KERNEL services in Python scripts\n The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services. -# How to use KERNEL services from a C++ context\n @@ -27,23 +26,23 @@ introductory documentation, listed below. \section S3_main Application Integrator - Applications integrators are in charge of configuration and installation of - specific %SALOME applications over a local network. Application Integrators - built %SALOME modules binaries from sources tarballs. +Applications integrators are in charge of configuration and installation of +specific %SALOME applications over a local network. Application Integrators +built %SALOME modules binaries from sources tarballs. -# How to install %SALOME\n - See \subpage INSTALL for general information on required configuration and + See \subpage INSTALL for general information on required configuration and prerequisites, compilation procedure, setting environment principles. -# How to configure a %SALOME application\n - See \ref SALOME_Application to define your own configuration of %SALOME and run it + See \ref SALOME_Application to define your own configuration of %SALOME and run it on one or several computers. This is the recommended way of configuration. \section S4_main Module maintainer - Module maintainers are in charge of the development and debug of the %SALOME - modules. Each %SALOME module is stored in a CVS base. CVS bases are organised - in separate branches for developments and debug. All official or development - releases are identified by a CVS tag. +Module maintainers are in charge of the development and debug of the %SALOME +modules. Each %SALOME module is stored in a CVS base. CVS bases are organised +in separate branches for developments and debug. All official or development +releases are identified by a CVS tag. -# Source code structuration and Unit Tests\n See \subpage UnitTests for general information on code directories structure, @@ -55,15 +54,24 @@ introductory documentation, listed below. \section S5_main SALOME programming model - You will find in the next pages informations about - specific points of %SALOME Kernel : +You will find in the next pages information about +specific points of %SALOME Kernel : - - \subpage kernel_salome - - \subpage dsc_page : DSC documentation page. - - \subpage salome_file_page : Salome_file documentation page. - - - Documentation of the KERNEL python package : The package salome.kernel provides - logging tools, high-level functions to handle items in Salome study, and other utilities. +- \subpage kernel_salome +- \subpage dsc_page : DSC documentation page. +- \subpage salome_file_page : Salome_file documentation page. +- \subpage python_documentation : The package salome.kernel provides + logging tools, high-level functions to handle items in Salome study, and other utilities. + + +\section S6_main SALOME KERNEL module Developer Documentation + +To browse the \b SALOME KERNEL module Developer Documentation, follow the links below or use navigation menu at the top of the page: + */