update

M-Schrapel · Oct 16, 2020 · 5707b74 · 5707b74
1 parent a01a383
commit 5707b74
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -3,22 +3,36 @@
 This repository demonstrates how easy we can bring emotions back to video chat programs when wearing face masks.
 Imagine you are in an important video meeting while you are at a public place or a train where face masks are mandatory. You could be misunderstood as you have limited opportunities to express your emotions.
 By attaching an ArUco marker to your face mask and using my python script, you can easily enhance your emotions. 
-I used this script to teach my students basics of augmented reality.
+I used this script to teach my students basics of augmented reality. The emojis were taken from [OpenMoji](https://openmoji.org/).
 
 ![Teaser](Tutorial/Teaser.jpg)
 
 ## Howto start
-- [Read the Tutorial](Tutorial/README.md))
+- [Read the Tutorial](Tutorial/README.md)
 - Print the ArUco marker
 - Cut out the marker with a white frame
 - Attach the marker
 
 <a href="url"><img src="ArUco_marker.jpg" align="center" height="100" width="100" ></a>
 
-![ArUco Marker](ArUco_marker.jpg)
+- Start your video chat program and select the OBS webcam
+- Start the Python script
+- Keep the window to the front to control the augmented output
+
+## Controls
+
+
+Key  | Function
+------------- | -------------
+0 to 9  | Overlay emoji
++  | Increase size of emoji
+-  | Decrease size of emoji
+w  | Stop overlaying emoji
+q  | Stop script
+
 
 
 ##
 ![HCI Group](Tutorial/Institute.png)
 
-This repository is provided by the Human-Computer Interaction Group at the University Hannover, Germany. For inquiries, please contact maximilian.schrapel@hci.uni-hannover.de
+This repository is provided by the Human-Computer Interaction Group at the University Hannover, Germany. For inquiries, please contact Maximilian Schrapel maximilian.schrapel@hci.uni-hannover.de
diff --git a/Tutorial/README.md b/Tutorial/README.md
@@ -22,7 +22,7 @@ After installing OBS Studio open a terminal, download the repository and start t
 ```sh
 $ git clone https://github.com/M-Schrapel/Webcam-Augmentation.git
 $ cd Webcam-Augmentation
-$ python .\emoji_webcam.py
+$ python emoji_webcam.py
 ```
 If you have any errors check if you have installed the right modules.
 ```sh
@@ -56,15 +56,15 @@ On the right of this window, you can now set up the virtual camera. Select the t
 Start your preferred video chat program and select the OBS-Camera.
 If your program is not able to find a camera stop the Python window by pressing q, search for camera in your video chat program again, select the OBS-Camera and restart the Python script.
 ```sh
-$ python .\emoji_webcam.py
+$ python emoji_webcam.py
 ```
 
-Everything should work now. By bringing the Phyton window to the front you can augment the webcam stream. Use the ArUco marker with the green and black color to make movements smooth.
+Everything should work now. By bringing the Phyton window to the front you can augment the webcam stream. Use the ArUco marker with the green and black color to make movements smooth. 
 
-![ArUco Marker](ArUco_marker.jpg)
+<a href="url"><img src="ArUco_marker.jpg" align="center" height="100" width="100" ></a>
 
 
 ##
 ![HCI Group](Tutorial/Institute.png)
 
-This repository is provided by the Human-Computer Interaction Group at the University Hannover, Germany. For inquiries, please contact maximilian.schrapel@hci.uni-hannover.de
+This repository is provided by the Human-Computer Interaction Group at the University Hannover, Germany. For inquiries, please contact Maximilian Schrapel maximilian.schrapel@hci.uni-hannover.de