Doc refresh

Author: Arthoni

CHANGELOG.md

@@ -1,3 +1,56 @@
+## 2.2.0
+
+  * Added git user injection in gitaskpass
+  * Added internal logging system for openfluid operations debug
+  * Added Qt6 compatibility, Qt5 compatibility kept but to be deprecated 
+  * Added CLI commands for ware operations
+  * Added multi-column generator
+  * Added capabilities about types and dimensions in single-column generator (integer, boolean, string)
+  * Added parameter structure to other wares than simulator (API get function, check in DevStudio)
+  * Added RNG seed as optional parameter for random generator
+  * Added constraints in data name characters (variables, unit class, attributes)
+  * Added functions to filesystem API
+  * Added template processing utility
+  * Added wheel event to clickable label
+  * Added build information to targets
+  * Added tools and workflows for automatic conversion of wares and ghosts to 2.2
+  * Added folder operations in DevStudio: git init, remove folder, remove fragment, add fragment
+  * Added code fragment feature to share code between wares
+  * Added search paths for code fragments (fragments subdir in ware, at workspace level, at userdata level)
+  * Added internal simulation test structure
+  * Added ware qualtiy checks
+  * Added ware status board in DevStudio for info and actions
+  * Added fluidx format version (current is 4)
+  * Added code tag types: HACK, TOIMPL
+  * Added tinyxml as third party library
+  * Added spatial display classes to API in ui/spatial
+  * Updated signature format from inline C++ macros to standalone interoperable json file
+  * Updated ghost file from xml to json
+  * Updated settings files format from conf to json (openfluid, project...)
+  * Updated C++ standard from 14 to 17
+  * Updated every enum to enum class
+  * Updated CMake minimum version to 3.10
+  * Updated DevStudio UX by splitting main toolbar
+  * Updated packaging stack for Windows to Msys2
+  * Updated example Firespread model to use multi-column generator
+  * Replaced sim2doc by docalyze utility to handle LaTeX, markdown and Rmd (uses pandoc, pdflatex and bibtex) 
+  * Replaced CLI buddies by generic commands
+  * Replaced rapidjson by nlohmannjson as third party library for json handling
+  * Updated ghost signature edition dialog for signature in DevStudio
+  * Updated chronological series classes to template
+  * Updated help of CLI commands (content and structure)
+  * Updated infra quality checks (more tests, prehook checks, quicker stylecheck)
+  * Updated packaging for Linux, Windows and MacOS
+  * Updated user documentation template and content
+  * Updated example simulators to 2.2
+  * Updated CI workflow with GitHub actions
+  * Updated translations
+  * Fixed GetUnit and diffInSeconds API functions
+  * Fixed simulation mode result discrepency
+  * Removed Qt from all non-UI libraries
+  * Removed landr library from repository (was disabled since 2.1.10)
+
+
 ## 2.1.11
 
   * Added display of help when openfluid command line is launched 

doc/contents/dev_createsim.md

@@ -26,23 +26,32 @@ Even if simulators can be developped using any text editor, the OpenFLUID-DevStu
 
 ## Creation of a simulator using OpenFLUID-DevStudio {#dev_createsim_ds}
 
+
+@note As the OpenFLUID-DevStudio UI is multilingual, the items cited below such as menu names or labels can be in another language than english for you installation.
+
 The OpenFLUID-DevStudio application is made of a main toolbar located on left, 
 a file navigator on the left side and a file editor on the right side.
 
 @image html screenshot_devstudio_overview.png "Screenshot of OpenFLUID-DevStudio workspace"
 @image latex screenshot_devstudio_overview.png "Screenshot of OpenFLUID-DevStudio workspace" width=11.5cm
 
-To create a new simulator, go to menu _File > New ware > Simulator..._ This opens the new simulator dialog dox. 
-In this dialog box, set the simulator ID and source files names then click _OK_. 
+To create a new simulator, go to menu _File > New ware > Simulator..._ This opens the new simulator dialog. 
+In this dialog, set the simulator ID and source files names then click _OK_. 
 The Source code of a new simulator is created.  
 
 @image html screenshot_devstudio_newware.png "Screenshot of new simulator dialog"
 @image latex screenshot_devstudio_newware.png "Screenshot of new simulator dialog" width=5.5cm
 
-Once created, click on the _Configure_ button of the main toolbar. Once the configure process is completed, 
-click on the _Build_ button to effectively build the simulator. Once the build process is completed, 
-the simulator is ready to use for simulations. The build process must be run each time 
-the simulator source code is modified to take into account these modifications.
+### Configuration phase
+Once created, the configuration phase must be performed at least once. Click on the _Configure_ button of the main toolbar. 
+This phase checks the dependencies (tools and libraries) required to build the simulator. It can be performed either in _Release_ mode for performance optimization (mode by default, recommended) or in _Debug_ mode to be used with an external debugger.
+
+### Build phase
+The build phase must be performed each time the source code has been modified. Once the configure process is completed, 
+click on the _Build_ button to effectively build the simulator. 
+
+This phase builds thes simulator source code into a binary plugin for the OpenFLUID platform. It can be performed either in _Build and install_ mode to make the simulator immediately available for simulations (mode by default, recommended) or in _Build only_ mode for intermediate builds for example.
+
 
 
 ## Complete source code example {#dev_createsim_exmpl}
@@ -64,3 +73,4 @@ including source code and build configuration using the OpenFLUID CMake module.
 ### File src/CMakeLists.txt defining the plugin build {#dev_createsim_exmpl_src_cmakelists}
 
 @include wares/src.CMakeLists.txt.snippet
+