Add readme

Author: martenrichter

readme.md

@@ -0,0 +1,26 @@
+# Fancy automated internet lecture system (**FAILS**) - components
+
+This package is part of FAILS.
+A web based system developed out of university lectures.
+Bascially it is a continous pen based notepad editor  delivering **electronic chalk**  to several beamers in the lecture hall.
+
+The students can follow the lecture also on their tablets and notebooks and can scroll independently and ask questions to the lecturer using a chat function.
+Furthermore polls can be conducted.
+
+After the lecture is completed a pdf can be downloaded at anytime.
+
+FAILS components is completely integrated using LTI into LMS such as Moodle.
+
+It is the reincarnation of a system, we are using at our theoretical physics institute for several years and currently under heavy *initial development*.
+
+The system is written with containerization and scalability in mind.
+
+Currently it is advided to **not use** FAILS in a productive environment.
+
+FAILS is licensed via GNU Affero GPL version 3.0 
+
+## Package noteshandler
+This package contains the node server code for handle students attending the lectures.
+
+## Installation
+For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.