From ada92cc0f53ad2aad0a1eb629d6de8ca5c2a29be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Darius=20Nea=C8=9Bu?= Date: Thu, 16 Jul 2026 10:32:35 +0300 Subject: [PATCH] Align build options and README with Beman Standard Add Dependencies/Build Environment documentation per exemplar #417 so libraries satisfy beman-tidy cpp.min_std_version (#362) and document cmake.skip_tests/cmake.skip_examples options. --- CMakeLists.txt | 9 ++++----- README.md | 18 +++++++++++++----- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 9e267995..7e01bc92 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -93,8 +93,8 @@ endif() #=============================================================================== option( - BEMAN_EXECUTION_ENABLE_TESTING - "Enable building tests and test infrastructure. Values: { ON, OFF }." + BEMAN_EXECUTION_BUILD_TESTS + "Enable building tests and test infrastructure. Default: ${PROJECT_IS_TOP_LEVEL}. Values: { ON, OFF }." ${PROJECT_IS_TOP_LEVEL} ) @@ -123,9 +123,8 @@ beman_install_library(${BEMAN_EXECUTION_TARGET_PREFIX} TARGETS ${BEMAN_EXECUTION ) #=============================================================================== -enable_testing() - -if(BEMAN_EXECUTION_ENABLE_TESTING) +if(BEMAN_EXECUTION_BUILD_TESTS) + enable_testing() add_subdirectory(tests/beman/execution) endif() diff --git a/README.md b/README.md index f2fe8499..4555f96f 100644 --- a/README.md +++ b/README.md @@ -49,13 +49,21 @@ There are plenty of things which need to be done. See the for some ideas how to contribute. The [resources page](https://github.com/bemanproject/execution/blob/main/docs/resources.md) contains some links for general information about the sender/receivers and `std::execution`. -## Build +## Dependencies -## Preconditions +### Build Environment -- cmake v3.30 or newer -- ninja v1.13.0 or newer -- A compiler that supports at least C++23 +This project requires at least the following to build: + +* A C++ compiler that conforms to the C++23 standard or greater +* CMake 3.30 or later +* (Test Only) GoogleTest + +You can disable building tests by setting CMake option `BEMAN_EXECUTION_BUILD_TESTS` to +`OFF` when configuring the project. + +You can disable building examples by setting CMake option `BEMAN_EXECUTION_BUILD_EXAMPLES` to +`OFF` when configuring the project. | Library | Linux | MacOS | Windows |