cyberbotics / epuck_ros2

ROS2 node for the e-puck robot and its simulation model
https://cyberbotics.com/doc/guide/epuck
Apache License 2.0
57 stars 19 forks source link

Create documentation #9

Closed lukicdarkoo closed 4 years ago

lukicdarkoo commented 4 years ago

The packages (especially epuck_ros2_cpp) are missing detailed documentation. Readme files such as the following two should be created:

lukicdarkoo commented 4 years ago

A huge amount of content required for the documentation can be shared with webots_ros2_epuck: https://github.com/cyberbotics/webots_ros2/blob/master/webots_ros2_epuck/README.md

How do we handle this? Do we copy and change the specific details, or we create common documentation + documentation specific to webots_ros2_epuck and epuck_ros2_cpp separately?

omichel commented 4 years ago

We should never copy as the copies will inevitably diverge at some point. The best is to document at one place and set a pointer to this documentation from the other place(s).