Skip to content

Commit

Permalink
Add README to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Friedman <[email protected]>
  • Loading branch information
Ryanf55 authored and Jaeyoung-Lim committed Jan 17, 2024
1 parent 7aba781 commit c8e6f97
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -8,7 +9,9 @@ This package provides a georeferenced extension to the elevation map [grid_map](

**Authors: Jaeyoung Lim<br />
Affiliation: [ETH Zurich, Autonomous Systems Lab](https://asl.ethz.ch/)<br />**

## Setup

Install the dependencies. This package depends on gdal, to read georeferenced images and GeoTIFF files.

Pull in dependencies using rosdep
Expand All @@ -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).

0 comments on commit c8e6f97

Please sign in to comment.