From 00742e3d91bc155c0ab7f89a15266d9d4eb17d67 Mon Sep 17 00:00:00 2001 From: fherrero <fherrero@iri.upc.edu> Date: Thu, 7 Mar 2019 16:52:54 +0100 Subject: [PATCH] Update README --- README.md | 31 +++++++++++++++++++++++++++++++ package.xml | 4 ++-- 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a31b197 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Description + +This package contains navigation related parameter and launch files particular to the Helena robot. + +# Dependencies + +This node has the following dependencies: + + * [iri_rosnav](https://gitlab.iri.upc.edu/labrobotica/ros/navigation/iri_rosnav) + +# Install + +This package, as well as all IRI dependencies, can be installed by cloning the +repository inside the active workspace: + +``` +roscd +cd ../src +git clone https://gitlab.iri.upc.edu/labrobotica/ros/robots/helena/iri_helena_rosnav.git +``` + +However, this package is normally used as part of a wider installation (i.e. a +robot, an experiment or a demosntration) which will normally include a complete +rosinstall file to be used with the [wstool](http://wiki.ros.org/wstool) tool. + +# How to use it + + * nav.launch: example using a navigation with a map and AMCL localization + * nav_mapping.launch: example using navigation with gmapping SLAM. + + See its arguments for more detail on configuration possibilities. \ No newline at end of file diff --git a/package.xml b/package.xml index d6c0cb8..4d57ebd 100644 --- a/package.xml +++ b/package.xml @@ -2,12 +2,12 @@ <package format="2"> <name>iri_helena_rosnav</name> <version>0.0.0</version> - <description>The iri_helena_rosnav package</description> + <description>This package contains navigation related parameter and launch files particular to the Helena robot. </description> <!-- One maintainer tag required, multiple allowed, one person per tag --> <!-- Example: --> <!-- <maintainer email="jane.doe@example.com">Jane Doe</maintainer> --> - <maintainer email="fherrero@iri.upc.edu">fherrero</maintainer> + <maintainer email="labrobotica@iri.upc.edu">IRI_labrobotica</maintainer> <!-- One license tag required, multiple allowed, one license per tag --> -- GitLab