From 264de187ece8d4bd75eb63f6a397ca05038ad0f5 Mon Sep 17 00:00:00 2001 From: Pascal Engeler <engelerp@phys.ethz.ch> Date: Mon, 20 Jan 2020 17:33:32 +0100 Subject: [PATCH] doc test --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a05e129..303cbba 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 -- GitLab