From d2445bf43ed217ad7ba85e865124d3799cf17460 Mon Sep 17 00:00:00 2001 From: Marc Hanheide Date: Thu, 16 Feb 2017 12:56:17 +0000 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2269ba9..a368d53 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,10 @@ -# spqrel_launch -This repository is designated to contain all launch files and config for competition task of team SPQR-eL +# SPQReL repository +This repository is designated to contain all launch files and config for competition task of team SPQReL + +The structure of this repo should be as follows: + +* one ROS package for every task of the competition, containing [`tmux`](https://tmux.github.io/) startup scripts (e.g. look at https://github.com/strands-project/aaf_deployment/blob/indigo-devel/aaf_bringup/scripts/aaf_start.sh for an example), a suitable package name would be `spqrel_speech_person_recog_bringup` +* one ROS package called `spqrel_configs` containing general definitions and SPQReL-specific parameters and configs. + +Attention should be paid to define all dependencies correctly in any `package.xml` to make sure that the correct dependencies can be pulled in automatically. +