Skip to content

Commit

Permalink
Some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jlblancoc committed Aug 27, 2023
1 parent b290770 commit c6ef2db
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 6 deletions.
22 changes: 22 additions & 0 deletions mrpt_map/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# mrpt_map

## Overview
This package provides a ROS 2 node for xxx


## Node: mrpt_map

### Working rationale
The C++ ROS 2 node...

### ROS Parameters
* ``initial_pose``: The initial pose mean and covariance. If using an occupancy gridmap, particles will be distributed
along free space cells only.
* xxx

### Subscribed topics
* xxx

### Published topics
* xxx

13 changes: 7 additions & 6 deletions mrpt_pf_localization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@
* [Demos](#demos)
* [Node: mrpt_pf_localization](#node-mrpt_pf_localization)
* [Working rationale](#working-rationale)
* [ROS-related documentation](#ros-related-documentation)
* [ROS 2 parameters:](#ros-2-parameters)
* [Subscribed topics:](#subscribed-topics)
* [Published topics:](#published-topics)

<!-- Created by https://github.com/ekalinin/github-markdown-toc -->


## Overview
Expand Down Expand Up @@ -83,16 +86,14 @@ the main functionality. It features an internal finite state machine (FSM) with
localize the robot.


### ROS-related documentation

Parameters:
### ROS 2 parameters:
* ``initial_pose``: The initial pose mean and covariance. If using an occupancy gridmap, particles will be distributed
along free space cells only.
* xxx

Subscribed topics:
### Subscribed topics:
* xxx

Published topics:
### Published topics:
* xxx

4 changes: 4 additions & 0 deletions mrpt_pf_localization/params/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This directory holds configuration files that may be used "as is" or with very few modifications
directly by end users, so it makes sense to distribute them along the package.

Other more specific examples may go into the mrpt_tutorials package instead.

0 comments on commit c6ef2db

Please sign in to comment.