Merge pull request #1 from estherag/rolling

Add readme and fix CI

Author: estherag

.github/workflows/rolling.yaml

@@ -35,10 +35,10 @@ jobs:
           colcon-defaults: |
             {
               "build": {
-                "packages-up-to": true
+                "packages-up-to": true,
+                  "mixin": ["coverage-gcc"]
               }
             }
-          colcon-mixin-name: coverage-gcc
           colcon-mixin-repository: https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml
 
       - name: Codecov

README.md

@@ -1,2 +1,36 @@
 # easynav_gridmap_stack
 
+
+This stack is part of the Easy Navigation (EasyNav) project developed by the Intelligent Robotics Lab. It is composed of the **gridmap_maps_builder** package and the **gridmap_maps_manager** package (currently under construction) for handling elevation maps.
+
+
+
+## Installation
+
+Clone the repository into your ROS 2 workspace:
+```bash
+cd ~/ros2_ws/src
+git clone https://github.com/EasyNavigation/easynav_gridmap_stack.git
+cd ..
+rosdep install --from-paths src --ignore-src -r -y
+colcon build --packages-select easynav_gridmap_maps_builder
+```
+
+## Usage
+
+Source your workspace:
+```bash
+source ~/ros2_ws/install/setup.bash
+```
+Run the lifecycle node:
+```bash
+ros2 run easynav_gridmap_maps_builder gridmap_maps_builder_node
+```
+
+## Parameters
+
+| Name                     | Type   | Default Value | Description |
+|--------------------------|--------|----------------|-------------|
+| `sensor_topic`           | string | `"points"`     | Topic name to subscribe for point cloud data. |
+| `downsample_resolution`  | double | `1.0`          | Resolution used for downsampling the point cloud. |
+| `perception_default_frame` | string | `"map"`      | Default frame ID for the output grid map. |

easynav_gridmap_maps_builder/package.xml

@@ -4,7 +4,7 @@
   <name>easynav_gridmap_maps_builder</name>
   <version>0.0.1</version>
   <description>Easy Navigation: Gridmap Map Builder Package.</description>
-  <maintainer email="e.aguado.glez@gmail.com">Esther Aguado Gonzalez</maintainer>
+  <maintainer email="francisco.romero@urjc.es">Francisco Jose Romero Ramirez</maintainer>
   <license>GPL-3.0-only</license>
 
   <buildtool_depend>ament_cmake</buildtool_depend>