From: Ovidiu Mircescu <ovidiu.mircescu@edf.fr>
Date: Fri, 6 Jan 2023 15:28:55 +0000 (+0100)
Subject: Add examples to README.
X-Git-Tag: V9_11_0a1~5
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=e54cf481d42e6ee2adaedf25911f7e91a094b78e;p=tools%2Fydefx.git

Add examples to README.
---

diff --git a/README.md b/README.md
index 758a5f1..d9b12be 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
-The goal of the ydefx library is a tool to make parametric computations on
-distributed resources. It can launch the computations on a remote cluster using
-a batch manager.
+# YDEFX
+Ydefx library is a tool to make parametric computations on distributed
+resources. It can launch the computations on a remote cluster using a batch
+manager.
 
 This library uses the Salome modules KERNEL and YACS.
+
+## Examples
+
+[Example of use explained in french.](src/pyexample/exemple_fr.py)
+[Minimalistic example.](src/pyexample/tests1.py)
+[Example using a different job for each evaluation.](src/pyexample/multijob/launch_multi.py)
+[Example using srun instead of YACS for distribution.](src/pyexample/multijob/launch_srun.py)