Skip to content

Commit

Permalink
Fix readme issues (#449)
Browse files Browse the repository at this point in the history
Signed-off-by: Van Malleghem Antoine <antoine.vanmalleghem@botronics.be>
  • Loading branch information
avanmalleghem authored Sep 3, 2024
1 parent 3b33067 commit 2425121
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/ico

[Folder Structure](#folder-structure)

[Code of Conduct](#code-of-conduct)
[Contributing](#contributing)

[Contributing](#code-of-contributing)
[Code of Conduct](#code-of-conduct)

[Versioning](#versioning)

[License](#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.
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.

Expand Down Expand Up @@ -94,12 +94,14 @@ Replace `/path/to/install/dir` to whatever directory you want to install this pa
# Usage

Documentation can be accessed at https://gazebosim.org/libs/cmake
[Examples](examples/) are available in this repository.
[Tutorials](tutorials/) are also available in this repository.

[Examples](https://github.com/gazebosim/gz-cmake/tree/gz-cmake4/examples) are available in this repository.

[Tutorials](https://github.com/gazebosim/gz-cmake/tree/gz-cmake4/tutorials) are also available in this repository.

# Documentation

Documentation for `gz-cmake` can be found within the source code, and also in the [MIGRATION.md guide](https://github.com/gazebosim/gz-cmake/blob/master/MIGRATION.md).
Documentation for `gz-cmake` can be found within the source code, and also in the [MIGRATION.md guide](https://github.com/gazebosim/gz-cmake/blob/gz-cmake4/Migration.md).

# Testing

Expand All @@ -124,8 +126,8 @@ $ make test

# Contributing

Please see
[CONTRIBUTING.md](https://gazebosim.org/docs/all/contributing).
Please see the
[contribution guide](https://gazebosim.org/docs/all/contributing).

# Code of Conduct

Expand Down

0 comments on commit 2425121

Please sign in to comment.