Gazebo CMake : CMake Modules for Gazebo Projects

Maintainer: scpeters AT openrobotics.org

Build	Status
Ubuntu Noble
Homebrew
Windows

Table of Contents

Features

Install

• Binary Install

• Source Install

  • Prerequisites

  • Building from Source

Usage

Documentation

Testing

Folder Structure

Contributing

Code of Conduct

Versioning

License

Features

gz-cmake provides a set of cmake modules that are used by the C++ based Gazebo projects. These modules help to control the quality and consistency of the Gazebo projects build systems.

These modules are tailored to the Gazebo projects, so their use for non-Gazebo projects might be limited, but they may serve as a useful reference for setting up a modern cmake build system using good practices.

Install

We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible.

The Source Install instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.

Binary Install

On Ubuntu systems, apt-get can be used to install gz-cmake:

sudo apt install libgz-cmake<#>-dev

Be sure to replace <#> with a number value, such as 1 or 2, depending on which version you need.

Source Install

Prerequisites

The only prerequisite of gz-cmake is cmake. Ubuntu users can install cmake with the package manager:

sudo apt install cmake

Building from source

To build and install from source, you can clone the repo and use cmake to install the modules as though this is a regular cmake project:

git clone https://github.com/gazebosim/gz-cmake
cd gz-cmake
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install/dir
make -j8
make install

Replace /path/to/install/dir to whatever directory you want to install this package to.

Usage

Documentation can be accessed at https://gazebosim.org/libs/cmake

Examples are available in this repository.

Tutorials are also available in this repository.

File truncated at 100 lines see the full file

See the Gazebo contributing guide.