Add usage notes, tweak app XML files

roboticslab-uc3m · Nov 6, 2023 · 64fd6fd · 64fd6fd
1 parent 8167567
commit 64fd6fd
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,21 @@
 # Teo-self-presentation
 
-This is a demostration of the humanoid robot Teo which presents himself (Press image to see the [video](https://www.youtube.com/watch?v=flyQq09S5GI))
-
-How to run the demo: [Spanish guide](https://robots.uc3m.es/teo-developer-manual/demo-procedure.html)
+Demonstration of the humanoid robot TEO presenting itself ([video](https://www.youtube.com/watch?v=flyQq09S5GI)).
 
 [![IMAGE ALT TEXT](http://i3.ytimg.com/vi/flyQq09S5GI/maxresdefault.jpg)](https://www.youtube.com/watch?v=flyQq09S5GI "Teo Self Presentation")
 
 ## Installation
 
 Installation instructions for installing from source can be found [here](doc/teo-self-presentation-install.md).
 
+## Usage
+
+Refer to the [demo procedure guide](https://robots.uc3m.es/teo-developer-manual/demo-procedure.html) for the initial robot setup steps.
+
+Once installed, run `yarpmanager` and look for the language version of the launcher XML file you are most interested in (teo-self-presentation_*language*.xml). If not present, you can manually add this application by means of the "Open File" or "Import Folder" buttons.
+
+Double click on the app and press "Run all", await until all modules have successfully loaded. Then, press "Connect all". The robot should start moving and speaking.
+
 ## Contributing
 
 #### Posting Issues
@@ -29,6 +35,4 @@ Installation instructions for installing from source can be found [here](doc/teo
 
 [![CI (Linux)](https://github.com/roboticslab-uc3m/teo-self-presentation/workflows/Continuous%20Integration/badge.svg)](https://github.com/roboticslab-uc3m/teo-self-presentation/actions)
 
-[![Coverage Status](https://coveralls.io/repos/roboticslab-uc3m/teo-self-presentation/badge.svg)](https://coveralls.io/r/roboticslab-uc3m/teo-self-presentation)
-
 [![Issues](https://img.shields.io/github/issues/roboticslab-uc3m/teo-self-presentation.svg?label=Issues)](https://github.com/roboticslab-uc3m/teo-self-presentation/issues)
diff --git a/doc/teo-self-presentation-install.md b/doc/teo-self-presentation-install.md
@@ -3,7 +3,7 @@
 First install the dependencies:
 - [Install CMake 3.16+](https://github.com/roboticslab-uc3m/installation-guides/blob/master/install-cmake.md)
 - [Install YCM 0.11+](https://github.com/roboticslab-uc3m/installation-guides/blob/master/install-ycm.md)
-- [Install YARP 3.6+](https://github.com/roboticslab-uc3m/installation-guides/blob/master/install-yarp.md)
+- [Install YARP 3.7+](https://github.com/roboticslab-uc3m/installation-guides/blob/master/install-yarp.md)
 - [Install SPEECH](https://github.com/roboticslab-uc3m/speech/blob/master/doc/speech-install.md) (only required by dialogueManager)
 
 ### Install teo-self-presentation demo on Ubuntu
@@ -13,10 +13,10 @@ Note that you will be prompted for your password upon using `sudo` a couple of t
 ```bash
 cd  # go home
 mkdir -p repos; cd repos  # create $HOME/repos if it does not exist; then, enter it
-git clone https://github.com/roboticslab-uc3m/teo-self-presentation.git  # Download teo-self-presentation demostration software from the repository
-cd teo-self-presentation; mkdir build; cd build; cmake ..  # Configure the teo-self-presentation demostration software
-make -j$(nproc)  # Compile
-sudo make install  # Install :-)
+git clone https://github.com/roboticslab-uc3m/teo-self-presentation.git  # download sources
+cd teo-self-presentation && mkdir build && cd build && cmake ..  # configure via CMake
+make -j$(nproc)  # compile
+sudo make install  # install
 cp ../scripts/gnome/teo-self-presentation.desktop $HOME/Desktop
 ```
 

diff --git a/share/applications/teo-self-presentation_english.xml b/share/applications/teo-self-presentation_english.xml
@@ -24,6 +24,9 @@
         <name>bodyExecution</name>
         <parameters>--robot /teo</parameters>
         <node>localhost</node>
+        <dependencies>
+            <port timeout="10.0">/teo/sync:o</port>
+        </dependencies>
     </module>
 
     <connection>

diff --git a/share/applications/teo-self-presentation_spanish.xml b/share/applications/teo-self-presentation_spanish.xml
@@ -24,6 +24,9 @@
         <name>bodyExecution</name>
         <parameters>--robot /teo</parameters>
         <node>localhost</node>
+        <dependencies>
+            <port timeout="10.0">/teo/sync:o</port>
+        </dependencies>
     </module>
 
     <connection>