diff --git a/README.md b/README.md index aa7dd18..f1653c5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # grid_map_geo + [![Build Test](https://github.com/ethz-asl/grid_map_geo/actions/workflows/build_test.yml/badge.svg)](https://github.com/ethz-asl/grid_map_geo/actions/workflows/build_test.yml) This package provides a georeferenced extension to the elevation map [grid_map](https://github.com/ANYbotics/grid_map) using [GDAL](https://gdal.org/), library for raster and vector geospatial data formats @@ -8,7 +9,9 @@ This package provides a georeferenced extension to the elevation map [grid_map]( **Authors: Jaeyoung Lim
Affiliation: [ETH Zurich, Autonomous Systems Lab](https://asl.ethz.ch/)
** + ## Setup + Install the dependencies. This package depends on gdal, to read georeferenced images and GeoTIFF files. Pull in dependencies using rosdep @@ -23,9 +26,15 @@ Build the package ``` colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release --packages-up-to grid_map_geo ``` + ## Running the package + The default launch file can be run as the following command. ``` source install/setup.bash ros2 launch grid_map_geo load_tif_launch.xml ``` + +## API Documentation + +Documentation for the C++ API in grid_map_geo is [here](https://ethz-asl.github.io/grid_map_geo/index.html). \ No newline at end of file