diff --git a/README.md b/README.md index 9eb9fc6b733e2f41af3c21fdd3415913520a87f5..e13d9fcd0ddaabd3b554a09edce237d404caf545 100644 --- a/README.md +++ b/README.md @@ -28,25 +28,38 @@ For permanently maintaining the overlay, source the setup.bash file at the end o ## Configuring the needed GIT repositories into the workspace +I-Dress packages: + ```bash $ 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: + +IRI dependencies (needed for compiling packages developed at IRI): + +```bash +$ wstool merge http://www.iri.upc.edu/people/sfoix/iri-core.rosinstall +$ wstool update +``` + +Your *src* folder should look like this: ```bash idress_common_msgs idress_force_perception idress_reactive_security + idress_shoe_decision_making + idress_shoe_perception idress_speech_perception idress_user_perception + idress_wam_interpreter + iri_core ``` -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. +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 required, 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. -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/) +Developers should not push any code directly to these two repositories but into temporal branches or forks based on them. Once the code is sufficiently tested within the temp branch, a merge to the corresponding *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/) for learning the most used commands, and see [Pro - Git book] (http://book.git-scm.com/) for acquiring a deeper knowledge.