tu-darmstadt-ros-pkg / hector_localization

The hector_localization stack is a collection of packages, that provide the full 6DOF pose of a robot or platform.
83 stars 61 forks source link

Documentation #1

Open NikolausDemmel opened 11 years ago

NikolausDemmel commented 11 years ago

I found this library via your post on ROS answers [1]. At first glance it seems like a really nice and powerful framework. As you mentioned in your answer one of the current issues is the lack of documentation. I believe this library could be very valuable to a number of people including myself if there was at least a little bit of help to get started. In my opinion the following documentation would be helpful with in order of decreasing immediate usefulness.

1) General overview over architecture of framework. 2) Tutorial how to use the current components. 3) Tutorial how to extend various parts of the system with new/altered components. 4) Code documentation of classes/functions/etc...

I know time is most always scarce, but if you get round to creating some initial documentation, maybe you can consider this order of priority (to the extend you agree with it of course).

Cheers, Nikolaus

[1] http://answers.ros.org/question/39790/robot_pose_ekf-and-gps/