Skip to content

Merge 4 -> main #504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scpeters merged 3 commits into from
Jul 15, 2025
Merged

Merge 4 -> main #504

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
791cdd5
Added doxygen in documentation for requirements and code snippet form…
PimpMyPizza Jun 23, 2025
03fbecf
Package doxygen is not required to build from source. (#503)
PimpMyPizza Jun 25, 2025
7fd4977
Merge branch 'gz-cmake4' into merge_4_main_20250714
iche033 Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ The [Source Install](#source-install) instructions should be used if you need th

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

```
$ sudo apt install libgz-cmake<#>-dev
```bash
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.
Expand All @@ -71,22 +71,22 @@ Be sure to replace `<#>` with a number value, such as `1` or `2`, depending on w

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

```
$ sudo apt install cmake
```bash
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
```bash
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.
Expand All @@ -108,9 +108,9 @@ Documentation for `gz-cmake` can be found within the source code, and also in th
A fuller suite of tests in the `examples` directory can be enabled by building with `BUILDSYSTEM_TESTING` enabled.
Tests can be run by building the `test` target. From your build directory you can run:

```
$ cmake .. -DBUILDSYSTEM_TESTING=1
$ make test
```bash
cmake .. -DBUILDSYSTEM_TESTING=1
make test
```

# Folder Structure
Expand Down
Loading