Skip to content

Commit

Permalink
add page with guide to install mcap with cmake (#1190)
Browse files Browse the repository at this point in the history
### Changelog
Add a page to `website` with the guide on how to install MCAP with
Cmake.

### Description
This follows conversation from
https://foxglove.slack.com/archives/C02H1JXG3C3/p1719462475680899

---------

Co-authored-by: Devon Rueckner <indirectlylit@users.noreply.github.com>
  • Loading branch information
filippobrizzi and indirectlylit committed Jul 16, 2024
1 parent 95e2b44 commit 05505c7
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
9 changes: 9 additions & 0 deletions cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,18 @@ following dependencies:
If your project does not need `lz4` or `zstd` support, you can optionally disable these by defining
`MCAP_COMPRESSION_NO_LZ4` or `MCAP_COMPRESSION_NO_ZSTD` respectively.

### Conan

To simplify installation of dependencies, the [Conan](https://conan.io/) package
manager can be used with the included
[conanfile.py](https://github.com/foxglove/mcap/blob/main/cpp/mcap/conanfile.py).

### CMake

For using MCAP with CMake, the third-party [olympus-robotics/mcap_builder](https://github.com/olympus-robotics/mcap_builder) repository provides a helpful wrapper.

### Alternatives

If you use an alternative approach, such as CMake's FetchContent or directly
vendoring the dependencies, make sure you use versions equal or greater than the
versions listed above.
Expand Down
9 changes: 9 additions & 0 deletions website/docs/guides/cpp/cmake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
description: Build and use MCAP C++ library with CMake.
---

# Build MCAP with CMake

If you want to add MCAP to your C++ project that uses CMake, the third-party [olympus-robotics/mcap_builder](https://github.com/olympus-robotics/mcap_builder) repository provides a helpful wrapper.

The readme file in that repository provides the steps and the context needed.

0 comments on commit 05505c7

Please sign in to comment.