From da09b91d6ff4074936d996367d283ba301eec118 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Darius=20Nea=C8=9Bu?= Date: Thu, 16 Jul 2026 10:34:04 +0300 Subject: [PATCH] docs: align README Build Environment 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. --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7601e9c..fb10eea 100644 --- a/README.md +++ b/README.md @@ -55,19 +55,24 @@ 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/task/blob/main/docs/resources.md) contains some links for general information about coroutines. -## Building beman.task +## Dependencies + +### Build Environment -### Dependencies +This project requires at least the following to build: -This project depends on -[`beman::execution`](https://github.com/bemanproject/execution) (which -will be automatically obtained using `cmake`'s `FetchContent*`). +* A C++ compiler that conforms to the C++23 standard or greater +* CMake 3.30 or later +* (Test Only) GoogleTest +* [`beman::execution`](https://github.com/bemanproject/execution) (auto-fetched via CMake FetchContent) -Build-time dependencies: +You can disable building tests by setting CMake option `BEMAN_TASK_BUILD_TESTS` to +`OFF` when configuring the project. -- `cmake` -- `ninja`, `make`, or another CMake-supported build system - - CMake defaults to "Unix Makefiles" on POSIX systems +You can disable building examples by setting CMake option `BEMAN_TASK_BUILD_EXAMPLES` to +`OFF` when configuring the project. + +## Building beman.task ### Supported Platforms