From e780b868713983568b766297817b0311b66178db Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20G=C3=BCnther?= <tom@toms-cafe.de>
Date: Sun, 24 Nov 2024 23:47:58 +0100
Subject: [PATCH] Add all cgmes versions to README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Thomas Günther <tom@toms-cafe.de>
---
 README.md | 31 ++++++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index cd2e5c77c..e75f373c0 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,24 @@
-libcimpp
-========
+# libcimpp
+
 libcimpp is a deserialiser library for C++ objects from XML/RDF documents based on the Common Information Model (CIM) standards (i.e. IEC61970/61968/62325) and CGMES for the energy sector.
 It is part of the CIM++ project. More on CIM++ can be found [here](http://rdcu.be/vOop).
 
 Supported CIM / CGMES versions:
-- [CGMES_2.4.15_27JAN2020](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_27JAN2020/annotated.html)
+
++ [CGMES_2.4.13_18DEC2013](https://sogno-platform.github.io/libcimpp/CGMES_2.4.13_18DEC2013/annotated.html)
++ [CGMES_2.4.15_16FEB2016](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_16FEB2016/annotated.html)
++ [CGMES_2.4.15_27JAN2020](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_27JAN2020/annotated.html)
++ [CGMES_3.0.0](https://sogno-platform.github.io/libcimpp/CGMES_3.0.0/annotated.html)
 
 ## General information
+
 limcimpp uses [arabica](http://www.jezuk.co.uk/cgi-bin/view/arabica) as cross platform wrapper around one of the XML parsers listed in the dependencies (see below).
 It is recommended to use libcimpp as cmake module.
 
 ## Dependencies
+
 You need following software packages for libcimpp:
+
 + One of the following XML parsers:
   + [libxml2](http://www.xmlsoft.org/) (usually chosen under Linux and often can be installed as a package of the used distribution)
   + [Xerces](http://xerces.apache.org/xerces-c/)
@@ -19,24 +26,26 @@ You need following software packages for libcimpp:
 + Build system:
   + [cmake](https://cmake.org/)
 
-
 ## Build instructions
 
 ### UNIX / Linux / MacOS
 
 After getting the Git repository, create a build subdirectory and change into it:
+
 ```bash
 mkdir build
 cd build
 ```
 
 For building libcimpp with the default CIM version, type:
+
 ```bash
 cmake ..
 make -j 4
 ```
 
 For building libcimpp with a certain CIM version (e.g. `CGMES_2.4.15_27JAN2020`), type:
+
 ```bash
 cmake .. -DUSE_CIM_VERSION=CGMES_2.4.15_27JAN2020
 make -j 4
@@ -45,11 +54,12 @@ make -j 4
 All available CIM versions are listed in the [CMakeLists.txt](CMakeLists.txt)
 
 ### Windows with MS Visual Studio
+
 1. After getting the Git repository, create a `build` subdirectory.
 2. Run the Windows CMake (GUI)
 3. Set the
-* source code directory, e.g.: `C:/git/libcimpp`
-* build directory, e.g.: `C:/git/libcimpp/build`
+   + source code directory, e.g.: `C:/git/libcimpp`
+   + build directory, e.g.: `C:/git/libcimpp/build`
 4. Click on `Configure` and choose the Visual Studio project version, e.g.: `Visual Studio 15 2017`
 5. Click on `Finish` and wait while CMake is configuring the project.
 6. Click on `Generate` to generate the Visual Studio project files.
@@ -57,10 +67,17 @@ All available CIM versions are listed in the [CMakeLists.txt](CMakeLists.txt)
 8. In Visual Studio's main menu choose `Build -> Build Solution`. This will build the `libcimpp` library.
 
 ## Usage of the libcimpp library
+
 For information on how to use the library please see the cmake based example in examples/cmake.
 Building the example is just like building the library itself using cmake.
+
+```bash
+cmake .. -DCIMPP_BUILD_EXAMPLES=ON
+make -j 4
+```
+
 The make example is currently not supported due to the lack of an install target for arabica.
 
 ## License
 
-This project is released under the terms of the [Apache License 2.0](./LICENSE).
\ No newline at end of file
+This project is released under the terms of the [Apache License 2.0](./LICENSE).