Skip to content

Commit 1ec517c

Browse files
committed
Add init and renaming to README.md
1 parent 8da95c0 commit 1ec517c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,18 @@ configure a serial terminal program. The COM port usually will be configured as
3131
If everything works fine, you will see the device boot, and it will then automatically log you in as
3232
xilinx.
3333

34+
## Initialize repository
35+
36+
Since the generation of the hardware-mapped topics rely on raw message definition files, the mandatory submodules have to be updated after clone.
37+
38+
```bash
39+
$ git submodule init && git submodule update
40+
```
41+
42+
### Knows Issues
43+
44+
The naming of standard message types is not consistant for ROS 2. Therefore, the naming of the message definition file must be changed for some cases (e.g. for the ReconROS Turtlebot 3 example, the UINT64 definition file (`UInt64.msg` to `U_Int64.msg`))
45+
3446
## Installing
3547
ReconROS uses an emulated docker container for the compilation of the application and building costum ROS message packages.
3648

0 commit comments

Comments
 (0)