From 74831d1208e8defb24527d6691d0c6f21e97c64a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Darius=20Nea=C8=9Bu?= Date: Thu, 16 Jul 2026 10:33:39 +0300 Subject: [PATCH 1/2] 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 | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 54b716c..e61bf97 100644 --- a/README.md +++ b/README.md @@ -105,23 +105,27 @@ import beman.scope; ``` With modules import needs to be after any includes to avoid compilation errors. -## Building beman.scope +## Dependencies -Building is only required to run tests and examples. All compilers build and -run `include` based tests. Compilers known to support modules are automatically -detected added to tests. +### Build Environment + +This project requires at least the following to build: -### Build Dependencies +* A C++ compiler that conforms to the C++20 standard or greater +* CMake 3.30 or later +* (Test Only) Catch2 -The library itself has no build dependencies other than Catch2 for testing. -And for building cmake and ninja. Makefiles are supported in non-modular builds. +You can disable building tests by setting CMake option `BEMAN_SCOPE_BUILD_TESTS` to +`OFF` when configuring the project. -Build-time dependencies: +You can disable building examples by setting CMake option `BEMAN_SCOPE_BUILD_EXAMPLES` to +`OFF` when configuring the project. -- `cmake` -- `ninja`, `make`, or another CMake-supported build system - - CMake defaults to "Unix Makefiles" on POSIX systems -- `catch2` for building tests +## Building beman.scope + +Building is only required to run tests and examples. All compilers build and +run `include` based tests. Compilers known to support modules are automatically +detected added to tests. ### Supported Platforms From f676a07bb004e0997acc4ccc3b91925a629b8448 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Darius=20Nea=C8=9Bu?= Date: Wed, 22 Jul 2026 23:26:19 +0300 Subject: [PATCH 2/2] Restore build-time dependencies section in README. Keep Build Dependencies under Building beman.scope per review feedback. Co-authored-by: Cursor --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e61bf97..ca902c5 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,18 @@ Building is only required to run tests and examples. All compilers build and run `include` based tests. Compilers known to support modules are automatically detected added to tests. +### Build Dependencies + +The library itself has no build dependencies other than Catch2 for testing. +And for building cmake and ninja. Makefiles are supported in non-modular builds. + +Build-time dependencies: + +- `cmake` +- `ninja`, `make`, or another CMake-supported build system + - CMake defaults to "Unix Makefiles" on POSIX systems +- `catch2` for building tests + ### Supported Platforms | Compiler | Version | C++ Standards | Standard Library |