From 3f2e9ee842415c72a62afd3e48ed0f6d5ad0bb32 Mon Sep 17 00:00:00 2001
From: Antonio Andriella <aandriella@iri.upc.edu>
Date: Wed, 4 Aug 2021 11:40:20 +0200
Subject: [PATCH] update package documentation

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 16e0444..df8b03b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
-# robot_facial_expression
-## This repository contains an edited version of the baxter facial expression package. Facial expressions are customized to be used on a Tiago robot
+# Repo used to generate TIAGo Facial expressions
+
+#### "Most of the code is taken from the great work of  [Bilgehan NAL](git@github.com:bilgehannal/baxter_face_software.git)  on the Baxter robot" 
+#### 
+
+
+
+#### Package:
+- **face_builder** folder contains all the png images used to build the robot's face.
+- **launch** folder contains the ros launch file
+- **script** folder contains the code to build the face. Most of the code has been got from the work of Bilgehan NAL and just a few things have been edited or removed in order to get it working with the TIAGo.
+
+
+
+How to run it:
+
+``` 
+ roslaunch robot_face_expression robot_face_expression.launch 
+```
+
+To visualise the different facial expressions you have to run the [robot_face_visualizer](git@github.com:aandriella/robot_face_visualizer.git) node as follows:
+
+``` 
+ rosrun robot_face_visualizer face_visualizer.py
+```
+
-- 
GitLab