Change Readme.md

README.md

@@ -1,2 +1,22 @@
-# Bachelorarbeit-Cozmo
-Unity ML-Agents project to teach the cozmo bot to follow a line (Reinforcement Learning)
+# Reinforcement Learning with Cozmo and Unity
+
+This project uses Reinforcement Learning to teach a virtual Cozmo-Robot to follow a Line drawn on the ground.The plugin ML-Agents for Unity is used to train the robot. A camera together with OpenCvSharp identifies the Line. Based on the Center of Gravity the reward is calculated for the robot. After the training the result is a model file which can be used by the real robot. A python project controls the real cozmo using the pretrained model.
+
+# Testing the project:
+
+The different models are already pretrained and can be used out of the box. To test the real robot you need to:
+
+1. look if you have a smartphone that is able to use the app for the cozmo robot. A list can be found here:       https://support.anki.com/hc/de/articles/360004696273
+
+2. install the app on your smartphone and connect it to the robot:
+https://support.anki.com/hc/de/articles/230119948-Wie-kann-ich-Cozmo-aufwecken-und-eine-Verbindung-herstellen-
+
+3. set the cozmo app to use sdk mode and connect your smartphone to your pc using a cable
+
+4. open a command prompt and go to the PythonProject\BachelorarbeitCozmo\venv\Scripts folder
+
+5. execute the CozmoController.py by typing into the shell "python cozmocontroller.py"
+
+Alternatively you can open the project in PyCharm and Run the CozmoController.py
+
+If the program complains you might need to install some modules. These requirements are listed in the requirements.txt file which can be found in the PythonProject\BachelorarbeitCozmo\venv folder. Usually it should be enough to install the specific versions of "cozmo", "Pillow", "opencv-python" and "tensorflow", because all other modules are installed together with theses by default.