diff --git a/README.md b/README.md index c8f1ac42ff6dd5032c744908996d3472b9e38b59..a507c930ddb8067fd9c8001964bd051d7ce7a52b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,14 @@ # Description -This ROS package provide an easy way to launch the Ana robot with all its sensors -in the Gazebo simulator. +This ROS package provides an easy way to launch the robot platform and its sensors in the Gazebo simulator. # Dependencies This node has the following dependencies: - * [iri_skid_steering_gazebo](https://gitlab.iri.upc.edu/labrobotica/ros/platforms/iri_skid_steering_gazebo) - - * [iri_velodyne_gazebo](https://gitlab.iri.upc.edu/labrobotica/ros/sensors/ranger3d/iri_velodyne_gazebo) - - * [iri_imu_gazebo](https://gitlab.iri.upc.edu/labrobotica/ros/sensors/imu/iri_imu_gazebo) + * [gazebo_ros](http://wiki.ros.org/gazebo_ros) + * [iri_ana_description](https://gitlab.iri.upc.edu/labrobotica/ros/robots/ana/iri_ana_description) + * [iri_gazebo_worlds](https://gitlab.iri.upc.edu/labrobotica/ros/navigation/iri_gazebo_worlds) # Install @@ -25,16 +22,15 @@ git clone https://gitlab.iri.upc.edu/labrobotica/ros/robots/ana/iri_ana_gazebo.g ``` 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 +robot, an experiment or a demonstration) which will normally include a complete rosinstall file to be used with the [wstool](http://wiki.ros.org/wstool) tool. # How to use it -This package provides the *spawn_ana.launch* file to import the ana robot, with -all its sensors, to the Gazebo simulator. This launch file has the following -parameters: +This package provides the *spawn.launch* file to import the robot and its sensors to the Gazebo simulator. +This launch file has the following parameters: - * name: (default: ana) base name given to the robot related nodes. + * ns: (default: ana) base name given to the robot related nodes. This parameter is useful when dealing with multiple instances of the same robot. @@ -51,5 +47,5 @@ respect to the world frame. respect to the world frame. Also, an example launch file is provided (sim_sample.launch) which launches -an empty world and spawns the ana robot. This file can be used as an example -to create custom simulation launch files. +an empty world and spawns the robot. This file can be used as an example +to create custom simulation launch files. \ No newline at end of file diff --git a/package.xml b/package.xml index dcb863bb554dfc76112b80339491240c3a619f1f..aff2e321f726a7b9834263f2e1807ab45f9bf0f7 100644 --- a/package.xml +++ b/package.xml @@ -2,12 +2,12 @@ <package format="2"> <name>iri_ana_gazebo</name> <version>0.0.0</version> - <description>The iri_ana_gazebo package</description> + <description>Set of launch files to run and configure the robot in simulation</description> <!-- One maintainer tag required, multiple allowed, one person per tag --> <!-- Example: --> <!-- <maintainer email="jane.doe@example.com">Jane Doe</maintainer> --> - <maintainer email="labrobotica@iri.upc.edu">labrobotica</maintainer> + <maintainer email="labrobotica@iri.upc.edu">IRI_labrobotica</maintainer> <!-- One license tag required, multiple allowed, one license per tag -->