Skip to content

Commit c8e6f97

Browse files
Ryanf55Jaeyoung-Lim
authored andcommitted
Add README to docs
Signed-off-by: Ryan Friedman <[email protected]>
1 parent 7aba781 commit c8e6f97

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# grid_map_geo
2+
23
[![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)
34

45
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](
89

910
**Authors: Jaeyoung Lim<br />
1011
Affiliation: [ETH Zurich, Autonomous Systems Lab](https://asl.ethz.ch/)<br />**
12+
1113
## Setup
14+
1215
Install the dependencies. This package depends on gdal, to read georeferenced images and GeoTIFF files.
1316

1417
Pull in dependencies using rosdep
@@ -23,9 +26,15 @@ Build the package
2326
```
2427
colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release --packages-up-to grid_map_geo
2528
```
29+
2630
## Running the package
31+
2732
The default launch file can be run as the following command.
2833
```
2934
source install/setup.bash
3035
ros2 launch grid_map_geo load_tif_launch.xml
3136
```
37+
38+
## API Documentation
39+
40+
Documentation for the C++ API in grid_map_geo is [here](https://ethz-asl.github.io/grid_map_geo/index.html).

0 commit comments

Comments
 (0)