document how to run the logical_marker plugin (#95)

utexas-bwi · Jan 16, 2018 · 50e009a · 50e009a
1 parent a766b9b
commit 50e009a
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/bwi_planning_common/README.rst b/bwi_planning_common/README.rst
@@ -0,0 +1,15 @@
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Common scripts for BWI Logical Planning
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+logical_marker
+--------------
+
+This rqt plugin script is used to annotate a map. To run it, specify
+the map's YAML file, and the directory for storing its logical
+annotations.
+
+For example::
+
+  $ roscd utexas_gdc/maps/simulation/multimap2/3ne
+  $ rosrun bwi_planning_common logical_marker _map_file:=3ne.yaml _data_directory:=.