diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..35bb5dc7f350a81666d48ced4f2bc9a8f1c05373 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Description + +The iri_helena_bringup ROS package contains the launch files to set up and configure the Helena robot in ROS. + +# Dependencies + +This node has the following dependencies: + + * [iri_pioneer3_bringup](https://gitlab.iri.upc.edu/labrobotica/ros/platforms/Pioneer3/iri_pioneer3_bringup) + + * [iri_hokuyo_laser2d_bringup](https://gitlab.iri.upc.edu/labrobotica/ros/sensors/ranger2d/iri_hokuyo_laser2d_bringup) + +# 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_bringup.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 + +The *bringup.launch* launch file is intended to be included in any launch file +that needs the robot. + +To remap topics and services, use a global remap command. + +The *test.launch* launch file shows an example of use, including bringup, description and rviz. \ No newline at end of file diff --git a/package.xml b/package.xml index b1bd51463705a506b92d261bcbf353cbfbd69df8..9ec9b4adec27b48990d800ba51d49b3775d7edfd 100644 --- a/package.xml +++ b/package.xml @@ -2,12 +2,12 @@ <package format="2"> <name>iri_helena_bringup</name> <version>0.0.0</version> - <description>The iri_helena_bringup package</description> + <description>Set of launch files to run and configure 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="shernand@todo.todo">shernand</maintainer> + <maintainer email="labrobotica@iri.upc.edu">IRI labrobotica</maintainer> <!-- One license tag required, multiple allowed, one license per tag -->