Description
This MR aims at writing a first documentation of the various cmsgemos packages in order for the developers to better understand the software architecture.
This is far from being a finalized documentation but is the first step of a WIP MR. Feel free to already comment on it or add new ideas.
Related Issue
Closes #145
Types of changes
-
Bug fix (non-breaking change which fixes an issue) -
New feature (non-breaking change which adds functionality) -
Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
-
My code follows the code style of this project. -
My change requires a change to the documentation. -
I have updated the documentation accordingly. -
I have read the CONTRIBUTING document. -
I have added tests to cover my changes. -
All new and existing tests passed.