diff --git a/README.md b/README.md index e13d9fcd0ddaabd3b554a09edce237d404caf545..b8c435a24528996c7cf12ca4a8cd04b636f13c54 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# I-Dress Code Intallation steps +# I-Dress code intallation and configuration steps ## Catkin workspace -Although it is not necessary, we recommend to create a new ROS workspace to keep the I-Dress code in a clean structure. [ROS tutorial] (http://wiki.ros.org/catkin/Tutorials/create_a_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) -Create folder path and initialize the workspace: +Create the folder path and initialize the workspace: ```bash $ mkdir -p ~/idress_ws/src @@ -19,7 +19,7 @@ $ cd ~/idress_ws/ $ catkin_make ``` -Overlay this workspace: +Overlay the default workspace with this one: ```bash $ source devel/setup.bash @@ -56,10 +56,9 @@ Your *src* folder should look like this: 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 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. +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. 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. -