Merge branch 'L2SS-590' into 'master'

L2SS-590: Readme index

Closes L2SS-590

See merge request !269

README.md

@@ -5,6 +5,21 @@
 
 Station Control software related to Tango devices.
 
+# Index
+
+* [Docker compose documentation](docker-compose/README.md)
+  * [Timescaledb](docker-compose/timescaledb/README.md)
+  * [Jupyter startup files](docker-compose/jupyter/ipython-profiles/stationcontrol-jupyter/startup/README.md)
+  * [Tango Prometheus exporter](https://git.astron.nl/lofar2.0/ska-tango-grafana-exporter)
+* [ReadTheDocs (Sphinx / ReStructuredText) documentation](tangostationcontrol/docs/README.md)
+* Source code documentation
+  * [Attribute wrapper documentation](tangostationcontrol/tangostationcontrol/clients/README.md)
+  * [Archiver documentation](tangostationcontrol/tangostationcontrol/toolkit/README.md)
+  * [Adding a new tango device](tangostationcontrol/tangostationcontrol/devices/README.md)
+  * [HDF5 statistics](tangostationcontrol/tangostationcontrol/statistics_writer/README.md)
+* [Unit tests](tangostationcontrol/tangostationcontrol/test/README.md)
+* [Integration tests](tangostationcontrol/tangostationcontrol/integration_test/README.md)
+
 # Installation
 
 ## Prerequisites

tangostationcontrol/README.md

-# Tango Station Control Device wrappers
-
-This code provides an attribute_wrapper class in place of attributes for tango devices. the attribute wrappers contain additional code 
-that moves a lot of the complexity and redundant code to the background. 
-
-The tango Device class is also abstracted further to a "lofar_device" class. This class wraps 
-
-The only things required on the users part are to declare the attributes using the attribute_wrapper (see `example/example_device`),
-declare what client the attribute has to use in the initialisation and provide support for the used clients. 
-To see how to add support for new clients, see `clients/README.md`
-
-In addition it also provides an abstraction to the tango device, specifically for hardware devices. Examples of hardware devices 
-can be found in TODO and an empty template can be found in `HW_device_template.py`
-
-Requires numpy 
-```pip install numpy```
-
-Requires opcua 
-```pip install opcua```
-
-Requires pytango 
-```pip install pytango```
-
-### usage
-You can start the device by calling it in any console with:
-<Device_name>.py instance_name

tangostationcontrol/tangostationcontrol/clients/README.md

@@ -92,7 +92,7 @@ The attribute wrapper relies on 1 internal file. tango/tangostationcontrol/devic
 ## Closing
 The advantages of using attribute_wrapper class instead of the standard Tango Attribute class can be noted in the following example where, in the first part, an implementation of the standard class is presented, while in the second part the analogous implementation using an attribute_wrapper is shown.
 
-##From official Tango documentation #
+## From official Tango documentation
 ```python
 class PowerSupply(Device):