diff --git a/README.md b/README.md index 5bc8076536823eba6033933308d67eae85c645c0..9eb9fc6b733e2f41af3c21fdd3415913520a87f5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,6 @@ Create folder path and initialize the workspace: $ mkdir -p ~/idress_ws/src $ cd ~/idress_ws/src $ catkin_init_workspace - ``` Compile it: @@ -34,4 +33,20 @@ $ cd ~/idress_ws/src $ wstool merge http://www.iri.upc.edu/people/sfoix/idress-minimal.rosinstall $ wstool update ``` +This will make your src folder to look like this: +```bash + idress_common_msgs + idress_force_perception + idress_reactive_security + idress_speech_perception + idress_user_perception +``` + +Each package belongs to a separate Git repository. By default, there are two branches within each of the repositories: one called *master* and another one called *mock*. Both branches are protected and maintained by IRI (If necessary, this can be changed). The *master* branch is the one used for stable code. The *mock* branch should be used for allowing the developers to carry out mock tests. + +Developers should not push any code to these two repositories but develop into branches or forks based on them. Once the code is sufficiently tested, a merge to the stable branch can be requested. + +For those that are not familiar with GIT repositories, please have a look to [git - the simple guide] (http://rogerdudler.github.io/git-guide/) and [Pro - Git book] (http://book.git-scm.com/) + +