From 05505c776bb0e707c8e561e40b0efac501b45ac1 Mon Sep 17 00:00:00 2001 From: Filippo Brizzi Date: Tue, 16 Jul 2024 19:58:48 +0200 Subject: [PATCH] add page with guide to install mcap with cmake (#1190) ### 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 --- cpp/README.md | 9 +++++++++ website/docs/guides/cpp/cmake.md | 9 +++++++++ 2 files changed, 18 insertions(+) create mode 100644 website/docs/guides/cpp/cmake.md diff --git a/cpp/README.md b/cpp/README.md index fb09b4dbb3..a986e72cad 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -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. diff --git a/website/docs/guides/cpp/cmake.md b/website/docs/guides/cpp/cmake.md new file mode 100644 index 0000000000..af42e95d7b --- /dev/null +++ b/website/docs/guides/cpp/cmake.md @@ -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.