Skip to content

Commit 3935698

Browse files
authored
Feature/update readme (#73)
* Update vcs-tool instructions * Update README.md - Update TODO list - Update instructions about vcs tool * Add licens of vcs-tool
1 parent 1cf960c commit 3935698

File tree

2 files changed

+27
-9
lines changed

2 files changed

+27
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,34 @@ For the real robot [Ubuntu Mate 20.04](https://ubuntu-mate.org/download/arm64/fo
4343

4444
### Dependencies
4545

46-
The required Ubuntu packages are listed in the [documentation](./docs). Other ROS catkin packages such as [`rplidar_ros`](https://github.com/Slamtec/rplidar_ros) need to be cloned into the catkin workspace. It is planned to use [`vcstool`](https://github.com/dirk-thomas/vcstool) in the future to automate the dependency installtions.
46+
The required Ubuntu packages are listed in software package sections found in the [documentation](https://ros-mobile-robots.com/packages/packages-setup/#obtain-system-dependencies). Other ROS catkin packages such as [`rplidar_ros`](https://github.com/Slamtec/rplidar_ros) need to be cloned into the catkin workspace.
47+
48+
For an automated and simplified dependency installation process install the [`vcstool`](https://github.com/dirk-thomas/vcstool), which is used in the next steps.
49+
50+
```console
51+
sudo apt install python3-vcstool
52+
```
4753

4854
### :hammer: How to Build
4955

5056
To build the packages in this repository including the Remo robot follow these steps:
5157

52-
1. Clone this repository in the `src` folder of your ROS Noetic [catkin workspace](http://wiki.ros.org/catkin/Tutorials/create_a_workspace):
58+
1. `cd` into an existing ROS Noetic [catkin workspace](http://wiki.ros.org/catkin/Tutorials/create_a_workspace) or create a new one:
59+
```console
60+
mkdir -p catkin_ws/src
61+
```
62+
63+
2. Clone this repository in the `src` folder of your ROS Noetic catkin workspace:
64+
65+
```console
66+
cd catkin_ws/src
67+
```
5368

5469
```console
55-
catkin_ws/src$ git clone https://github.com/fjp/diffbot.git
70+
git clone https://github.com/fjp/diffbot.git
5671
```
5772

58-
2. Execute the `vcs import` command from the root of the catkin workspace and pipe in the `diffbot_dev.repos` or `remo_robot.repos` YAML file, depending on where you execute the command, either the development PC or the SBC of Remo to clone the listed dependencies. Run the following command only on your development machine:
73+
3. Execute the `vcs import` command from the root of the catkin workspace and pipe in the `diffbot_dev.repos` or `remo_robot.repos` YAML file, depending on where you execute the command, either the development PC or the SBC of Remo to clone the listed dependencies. Run the following command only on your development machine:
5974

6075
```
6176
vcs import < src/diffbot/diffbot_dev.repos
@@ -67,13 +82,13 @@ To build the packages in this repository including the Remo robot follow these s
6782
vcs import < src/diffbot/remo_robot.repos
6883
```
6984

70-
3. Install the requried binary dependencies of all packages in the catkin workspace using the following [`rosdep` command](http://wiki.ros.org/rosdep#Install_dependency_of_all_packages_in_the_workspace):
85+
4. Install the requried binary dependencies of all packages in the catkin workspace using the following [`rosdep` command](http://wiki.ros.org/rosdep#Install_dependency_of_all_packages_in_the_workspace):
7186

7287
```
7388
rosdep install --from-paths src --ignore-src -r -y
7489
```
7590

76-
4. After installing the required dependencies build the catkin workspace, either with [`catkin_make`](http://wiki.ros.org/catkin/commands/catkin_make):
91+
5. After installing the required dependencies build the catkin workspace, either with [`catkin_make`](http://wiki.ros.org/catkin/commands/catkin_make):
7792

7893
```console
7994
catkin_ws$ catkin_make
@@ -84,7 +99,7 @@ To build the packages in this repository including the Remo robot follow these s
8499
catkin_ws$ catkin build
85100
```
86101

87-
5. Finally, source the newly built packages with the `devel/setup.*` script, depending on your used shell:
102+
6. Finally, source the newly built packages with the `devel/setup.*` script, depending on your used shell:
88103

89104
For bash use:
90105

@@ -268,8 +283,6 @@ Possible useful packages:
268283

269284
### Tooling
270285

271-
- [`vcstool`](https://github.com/dirk-thomas/vcstool) to simplify external dependency installation
272-
- Adding instructions how to use [`rosdep`](http://wiki.ros.org/rosdep) to install required system dependencies
273286
- Use [clang format](https://clang.llvm.org/docs/ClangFormat.html) together with [`.clang-format`](https://github.com/PickNikRobotics/roscpp_code_format) file for `roscpp` to comply with [ROS C++ Style Guidelines](http://wiki.ros.org/CppStyleGuide)
274287

275288

open-source-license-acknowledgements-and-third-party-copyrights.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,8 @@ https://github.com/Slamtec/rplidar_ros/blob/master/LICENSE
4949
### UbiquityRobotics/raspicam_node
5050
License: BSD 3-Clause
5151
https://github.com/UbiquityRobotics/raspicam_node/blob/kinetic/LICENSE
52+
53+
54+
### Dirk Thomas/vcstool
55+
License: Apache
56+
https://github.com/dirk-thomas/vcstool/blob/master/LICENSE

0 commit comments

Comments
 (0)