diff --git a/README.md b/README.md index b8c435a24528996c7cf12ca4a8cd04b636f13c54..82ef980d0bd571ad8cc5be46c89d08e41fa00280 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # I-Dress code intallation and configuration steps +The overall code structure of the project is based on [I-Dress diagram (PDF)] (http://www.iri.upc.edu/people/sfoix/idress_diagram_v1.pdf) + ## Catkin workspace Although it is not necessary, we recommend to create a new ROS workspace to keep the I-Dress code in a separated and clean structure. [ROS tutorial] (http://wiki.ros.org/catkin/Tutorials/create_a_workspace) @@ -58,7 +60,8 @@ Your *src* folder should look like this: 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 is created in case that the developers want to carry out mock tests. -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. +Developers should not push any code directly to these two repositories but into temporal branches or forks instead. 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. +##