Update documentation in "Examples"

diff --git a/Examples/README.txt b/Examples/README.txt
new file mode 100644 (file)
index 0000000..415d042
--- /dev/null
+++ b/Examples/README.txt
@@ -0,0 +1,8 @@
+Here you find examples of use of YACSGEN for every type of component.
+
+In order to build and test the examples, you have to:
+- change the SALOME installation directory in exec.sh (SALOME_DIR)
+- run "build.sh"
+
+Every example contains a "build.sh" script which shows you how to build and
+test it. In the main directory, it builds and tests all the examples.

diff --git a/Examples/clean.sh b/Examples/clean.sh
index fa3620c7f081816f7e18437ba7a4d4e2ac28be92..4908e472e070ddb07b36fbe7fe5168b499ba5701 100755 (executable)
--- a/Examples/clean.sh
+++ b/Examples/clean.sh
@@ -1,4 +1,6 @@
 #/bin/bash
+# clean all examples
+
 script_dir=`dirname $0`
 cd $script_dir
 

diff --git a/Examples/cpp1/README.txt b/Examples/cpp1/README.txt
index 6703a6225a34a1edc86ac4bc24547e0199e452ff..db8d590407ed11d417b7780164b94f1f527984ef 100644 (file)
--- a/Examples/cpp1/README.txt
+++ b/Examples/cpp1/README.txt
@@ -1,16 +1,8 @@
 A C++ component dynamically loadable
 =========================================
 
-To build this example, modify the ../context.py file
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py ::
-
-  source <your prerequisite file>
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build and test the component.
 
 You should get a SALOME module in source form (cppcompos_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module cppcompos.

diff --git a/Examples/cpp2/README.txt b/Examples/cpp2/README.txt
index d167aa3bd1b67f23dcb48fe10aefc714aa39c31d..eefacf6b29eef89435bff1a16867b8588283179c 100644 (file)
--- a/Examples/cpp2/README.txt
+++ b/Examples/cpp2/README.txt
@@ -1,23 +1,12 @@
 A C++ standalone component (executable form)
 =================================================
 
-To build this example, modify the ../context.py file
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py ::
-
-  source <your prerequisite file>
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build and test the component.
 
 You should get a SALOME module in source form (cppcompos_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module cppcompos.
-
-To build the standalone component (executable named prog), execute the Makefile in the SALOME application environment::
-
-  ./appli/runSession make
+You also get the standalone component (executable named prog).
 
 To run a coupling:
 

diff --git a/Examples/fort1/README.txt b/Examples/fort1/README.txt
index 846cd4c3aef02765e284734975a296f3c904571d..57b8242a035bb937691c959bca98fb1ae4753fc3 100644 (file)
--- a/Examples/fort1/README.txt
+++ b/Examples/fort1/README.txt
@@ -1,24 +1,8 @@
 A Fortran component dynamically loadable
 =============================================
 
-To build this example, modify the ../context.py, ../makefile.inc and Makefile files
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-3- your FORTRAN compiler
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here)::
-
-  source <your prerequisite file>
-
-Build the code1 et code2 libraries ::
-
-  make
-
-and process components.py ::
-
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build and test the component.
 
 You should get a SALOME module in source form (fcompos_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module fcompos.

diff --git a/Examples/fort2/README.txt b/Examples/fort2/README.txt
index ded462078635d1de823ca08ffa9a580b70359be0..2f50e5c7d2f7c49e66e0cc3cf8937577ddb92c99 100644 (file)
--- a/Examples/fort2/README.txt
+++ b/Examples/fort2/README.txt
@@ -1,27 +1,12 @@
 A Fortran standalone component
 =================================
 
-To build this example, modify the ../context.py, ../makefile.inc and Makefile files
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-3- your FORTRAN compiler
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here)::
-
-  source <your prerequisite file>
-
-and process components.py ::
-
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build and test the component.
 
 You should get a SALOME module in source form (fcompos_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module fcompos.
-
-Build the code1 et code2 executables under the SALOME application environment::
-
-  ./appli/runSession make
+You also get the code1 et code2 executables.
 
 To run a coupling:
 

diff --git a/Examples/pygui1/README.txt b/Examples/pygui1/README.txt
index fb47288b9ef52097a639309cda297037abe535d5..ee110540e6bb939c3be53651bf885a1d61b75872 100644 (file)
--- a/Examples/pygui1/README.txt
+++ b/Examples/pygui1/README.txt
@@ -1,16 +1,8 @@
 A Python component dynamically loadable
 ===============================================
 
-To build this example, modify the ../context.py file
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py ::
-
-  source <your prerequisite file>
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build the component.
 
 You should get a SALOME module in source form (pycompos_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module pycompos.

diff --git a/Examples/pyth1/README.txt b/Examples/pyth1/README.txt
index 0b89847b9388d4cb388fa391e69e61bf19acf967..d57211f520789ce4ec671c64a8481f459796e1a1 100644 (file)
--- a/Examples/pyth1/README.txt
+++ b/Examples/pyth1/README.txt
@@ -1,16 +1,8 @@
 A Python component dynamically loadable
 ===============================================
 
-To build this example, modify the ../context.py file
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py ::
-
-  source <your prerequisite file>
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build and test the component.
 
 You should get a SALOME module in source form (pycompos_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module pycompos.

diff --git a/Examples/pyth2/README.txt b/Examples/pyth2/README.txt
index 88498ae081186c102594ed350b9813f1038c77ce..05ea69acf8a4b8c0730f1b9c502df9948df3869f 100644 (file)
--- a/Examples/pyth2/README.txt
+++ b/Examples/pyth2/README.txt
@@ -1,16 +1,8 @@
 A Python standalone component (in executable form)
 =======================================================
 
-To build this example, modify the ../context.py file
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py ::
-
-  source <your prerequisite file>
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build and test the component.
 
 You should get a SALOME module in source form (pycompos_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module pycompos.

diff --git a/Examples/test_compo.py b/Examples/test_compo.py
index a76bed32365056e8dad5d89a2f9f79413c09f2d1..d006b7e6590761713eb381d725327e172659aea2 100755 (executable)
--- a/Examples/test_compo.py
+++ b/Examples/test_compo.py
@@ -1,5 +1,7 @@
 #! /usr/bin/env python
 # -*- coding: utf-8 -*-
+# This test executes the coupling.xml schema found in the current directory
+# and verifies the execution state.
 import unittest
 
 import os

diff --git a/Examples/types1/README.txt b/Examples/types1/README.txt
index 77692820c068ec9429b967b3cf90f0d7d1644b4e..2fc0fbfab6b2b201a4a2ad493cd38dfb2ed7be22 100644 (file)
--- a/Examples/types1/README.txt
+++ b/Examples/types1/README.txt
@@ -1,16 +1,8 @@
 A test for several YACS types SALOME_TYPES and others
 =========================================================
 
-To build this example, modify the ../context.py file
-to take into account your configuration.
-
-1- your prerequisite file 
-2- your KERNEL_ROOT_DIR
-
-Then set the environment (including PYTHONPATH for YACSGEN, ../.. from here and execute components.py ::
-
-  source <your prerequisite file>
-  python components.py
+To build this example, modify the ../exec.sh file to take into account your configuration.
+Run build.sh to build and test the component.
 
 You should get a SALOME module in source form (module_SRC), its installation (install) and
 a SALOME application (appli) composed of modules KERNEL, GUI, YACS and the new module module.