Skip to content

Commit 1a25eed

Browse files
authored
Update README.md
Added information about the different development branches, their purpose and their compatibility to different Modelica IDEs.
1 parent c058bdc commit 1a25eed

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ The model library **BuildingControlLib** is released by Fraunhofer Institute for
1313

1414
### Dependencies
1515

16-
The libary uses models from the [**AixLib**-library](https://github.com/RWTH-EBC/AixLib), version 0.4.0 and models of the [Buildings-library](https://github.com/lbl-srg/modelica-buildings), version 4.0.0.
16+
The libary uses models from the [**AixLib**-library](https://github.com/RWTH-EBC/AixLib), version 0.4.0 and models of the [**Modelica Buildings library**](https://github.com/lbl-srg/modelica-buildings), version 4.0.0.
1717

18-
The library uses models from Modelica Standard Library version 3.2.2.
18+
The library uses models from **Modelica Standard Library** version 3.2.2.
1919

20-
The library has been tested with Dymola 2017 FD01 64bit on Windows 7 64bit.
20+
The library has been tested with **Dymola 2017 FD01 64bit** and the **Microsoft Visual Studio Professional 2010 C compiler** on **Windows 7 64bit**.
2121

2222
### Version
2323

@@ -212,6 +212,12 @@ You are invited to contribute to the development of **BuildingControlLib**.
212212
Issues can be reported using this site's [Issues section](https://github.com/TechnicalBuildingSystems/BuildingControlLib/issues).
213213
Furthermore, you are welcome to contribute via [Pull Requests](https://github.com/TechnicalBuildingSystems/BuildingControlLib/pulls).
214214

215+
| Branch | Purpose | IDE Compatibility |
216+
|:---|:---|:---|
217+
| master| This branch is always deployable and contains the official history and last official revision state of the library. | The branch is compatible to Dymola 2017 FD01. |
218+
| development | This branch is used to integrate new features between revisions into the library. If you want to contribute to the library by adding new features, please branch from development and later merge your completed work here. | The branch is compatible to Dymola 2017 FD01. |
219+
| continuousIntegration | Because of compatibility problems between different Modelica IDEs, we decided to make the master branch compatible to Dymola and this one to OpenModelica. Additionally this branch contains a test library, which is used by TravisCI after every change. | The branch is compatible to OpenModelica 1.11.0.|
220+
215221
We recommend the workflow as suggested by state-of-the-art Modelica libraries, e.g. as described in the [Wiki](https://github.com/RWTH-EBC/AixLib/wiki). of **AixLib** library.
216222

217223

0 commit comments

Comments
 (0)