Skip to content

docs: align README Build Environment with Beman Standard #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
neatudarius merged 2 commits into from
Jul 22, 2026
Merged

docs: align README Build Environment with Beman Standard #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74831d1
docs: align README Build Environment with Beman Standard
Jul 16, 2026
f676a07
Restore build-time dependencies section in README.
Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,22 @@ import beman.scope;
```
With modules import needs to be after any includes to avoid compilation errors.

## Dependencies

### Build Environment

This project requires at least the following to build:

* A C++ compiler that conforms to the C++20 standard or greater
* CMake 3.30 or later
* (Test Only) Catch2

You can disable building tests by setting CMake option `BEMAN_SCOPE_BUILD_TESTS` to
`OFF` when configuring the project.

You can disable building examples by setting CMake option `BEMAN_SCOPE_BUILD_EXAMPLES` to
`OFF` when configuring the project.

## Building beman.scope

Building is only required to run tests and examples. All compilers build and
Expand Down
Loading