diff --git a/README.md b/README.md index a05e129b4e2f0f931535568ffd8712fe544c490e..303cbba4794ef58590ec3c00699e5416ee927ca1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ +1. [ RBComb Simulation Framework. ](#RSF) +2. [ Classes. ](#Classes) + + +<a name="RSF"></a> # RBComb Simulation Framework This project aims at developing a framework that can be used to simulate any project that is to be undertaken on the RBComb platform. It is designed in modular fashion, such that it is flexible enough to adapt easily to any given situation. -## Structure +<a name="Classes"></a> +## Classes The code is structured in an object oriented approach. The classes that likely will not need to be adapted for a new situation are found in the `lib` folder. They are described in the following. Note that qualifiers, references and the like are discarded