Documentation, style and code performance update

[modules/adao.git] / README.txt

diff --git a/README.txt b/README.txt
index cdfb5f7591e9be0942dc939280799ac2553c13d4..4518d49a441e29b6c509c4d4a7a3782f1e14dae7 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -2,8 +2,8 @@
 ADAO: A module for Data Assimilation and Optimization
 =====================================================
 
-About
------
+About ADAO: A module for Data Assimilation and Optimization
+-----------------------------------------------------------
 
 **The ADAO module provides data assimilation and optimization** features in
 Python or SALOME context (see http://www.salome-platform.org/). Briefly stated,
@@ -16,12 +16,12 @@ the framework are also known under the names of *calibration*, *adjustment*,
 problems*, *Bayesian estimation*, *optimal interpolation*, *mathematical
 regularization*, *meta-heuristics for optimization*, *model reduction*, *data
 smoothing*, etc. More details can be found in the full ADAO documentation (see
-https://www.salome-platform.org/).
+https://www.salome-platform.org/ User Documentation dedicated section).
 
 Only the use of ADAO text programming interface (API/TUI) is introduced
 here. This interface gives ability to create a calculation object in a
 similar way than the case building obtained through the graphical
-interface (GUI). When one wants to elaborate "by hand" the TUI
+interface (GUI). When one wants to elaborate directly the TUI
 calculation case, it is recommended to extensively use all the ADAO
 module documentation, and to go back if necessary to the graphical
 interface (GUI), to get all the elements allowing to correctly set the
@@ -73,7 +73,7 @@ The license for this module is the GNU Lesser General Public License
 
     <ADAO, a module for Data Assimilation and Optimization>
 
-    Copyright (C) 2008-2021 EDF R&D
+    Copyright (C) 2008-2024 EDF R&D
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
@@ -91,10 +91,9 @@ The license for this module is the GNU Lesser General Public License
 
     See http://www.salome-platform.org/
 
-In addition, it is requested that any publication or presentation describing
+In addition, it is requested that any publication or presentation, describing
 work using this module, or any commercial or non-commercial product using it,
-cite at least one of at least one of the references below with the current year
-added:
+cite at least one of the references below with the current year added:
 
     * *ADAO, a module for Data Assimilation and Optimization*,
       http://www.salome-platform.org/