Skip to content

Commit 7c970e2

Browse files
committed
Add all cgmes versions to README.md
Signed-off-by: Thomas Günther <[email protected]>
1 parent 63bab71 commit 7c970e2

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

+24-7
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,51 @@
1-
libcimpp
2-
========
1+
# libcimpp
2+
33
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.
44
It is part of the CIM++ project. More on CIM++ can be found [here](http://rdcu.be/vOop).
55

66
Supported CIM / CGMES versions:
7-
- [CGMES_2.4.15_27JAN2020](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_27JAN2020/annotated.html)
7+
8+
+ [CGMES_2.4.13_18DEC2013](https://sogno-platform.github.io/libcimpp/CGMES_2.4.13_18DEC2013/annotated.html)
9+
+ [CGMES_2.4.15_16FEB2016](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_16FEB2016/annotated.html)
10+
+ [CGMES_2.4.15_27JAN2020](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_27JAN2020/annotated.html)
11+
+ [CGMES_3.0.0](https://sogno-platform.github.io/libcimpp/CGMES_3.0.0/annotated.html)
812

913
## General information
14+
1015
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).
1116
It is recommended to use libcimpp as cmake module.
1217

1318
## Dependencies
19+
1420
You need following software packages for libcimpp:
21+
1522
+ One of the following XML parsers:
1623
+ [libxml2](http://www.xmlsoft.org/) (usually chosen under Linux and often can be installed as a package of the used distribution)
1724
+ [Xerces](http://xerces.apache.org/xerces-c/)
1825
+ [Microsoft XML Parser](https://support.microsoft.com/en-en/help/324460) (this one is used per default when building with MS Visual Studio)
1926
+ Build system:
2027
+ [cmake](https://cmake.org/)
2128

22-
2329
## Build instructions
2430

2531
### UNIX / Linux / MacOS
2632

2733
After getting the Git repository, create a build subdirectory and change into it:
34+
2835
```bash
2936
mkdir build
3037
cd build
3138
```
3239

3340
For building libcimpp with the default CIM version, type:
41+
3442
```bash
3543
cmake ..
3644
make -j 4
3745
```
3846

3947
For building libcimpp with a certain CIM version (e.g. `CGMES_2.4.15_27JAN2020`), type:
48+
4049
```bash
4150
cmake .. -DUSE_CIM_VERSION=CGMES_2.4.15_27JAN2020
4251
make -j 4
@@ -45,22 +54,30 @@ make -j 4
4554
All available CIM versions are listed in the [CMakeLists.txt](CMakeLists.txt)
4655

4756
### Windows with MS Visual Studio
57+
4858
1. After getting the Git repository, create a `build` subdirectory.
4959
2. Run the Windows CMake (GUI)
5060
3. Set the
51-
* source code directory, e.g.: `C:/git/libcimpp`
52-
* build directory, e.g.: `C:/git/libcimpp/build`
61+
+ source code directory, e.g.: `C:/git/libcimpp`
62+
+ build directory, e.g.: `C:/git/libcimpp/build`
5363
4. Click on `Configure` and choose the Visual Studio project version, e.g.: `Visual Studio 15 2017`
5464
5. Click on `Finish` and wait while CMake is configuring the project.
5565
6. Click on `Generate` to generate the Visual Studio project files.
5666
7. Click on `Open Project` to open the project in Visual Studio.
5767
8. In Visual Studio's main menu choose `Build -> Build Solution`. This will build the `libcimpp` library.
5868

5969
## Usage of the libcimpp library
70+
6071
For information on how to use the library please see the cmake based example in examples/cmake.
6172
Building the example is just like building the library itself using cmake.
73+
74+
```bash
75+
cmake .. -DCIMPP_BUILD_EXAMPLES=ON
76+
make -j 4
77+
```
78+
6279
The make example is currently not supported due to the lack of an install target for arabica.
6380

6481
## License
6582

66-
This project is released under the terms of the [Apache License 2.0](./LICENSE).
83+
This project is released under the terms of the [Apache License 2.0](./LICENSE).

0 commit comments

Comments
 (0)