Cleanups to README.md and CONTRIBUTING.md#323
Merged
Conversation
Member
ednolan
commented
Mar 16, 2026
- Update CMake version in README
- Cookiecutter: Fix a missed minimum C++ version variable
- Remove language about C++20 range requirements in tests
- This should be obvious to users if and when they encounter the error, and this language kept being copied into the READMEs of other libraries when it wasn't relevant.
- Remove CMAKE_PREFIX_PATH parameter from CONTRIBUTING.md documentation
- This hasn't been necessary since 2a8725d but the update to the README was missed.
- Refactor "Integrate beman.exemplar into your project" README section
- This section is now split up into four sections: Build, Installation, CMake Configuration, and Using beman.exemplar. Some of the verbiage has been rewritten.
- Remove GitHub Codespace language from CONTRIBUTING.md
- I am sunsetting the Beman project's use of GitHub codespaces due to maintenance burden, and a poor developer experience caused by excessive load times for launching the codespace instances.
- Remove language around installing build requirements
- Information about how to install CMake, LLVM, and MSVC is a quick Google search away. This document is more valuable if we stick to the information that's specifically relevant to building Beman libraries.
- Refactor language in CONTRIBUTING.md
- There are no major changes to the substance of what the document communicates in this commit, but it rephrases some of the language to make it clearer.
This was bumped by f296dd5 but the change to the README was missed.
This should be obvious to users if and when they encounter the error; and this language kept being copied into the READMEs of other libraries when it wasn't relevant.
This hasn't been necessary since 2a8725d but the update to the README was missed.
This section is now split up into four sections: Build, Installation, CMake Configuration, and Using beman.exemplar. Some of the verbiage has been rewritten.
I am sunsetting the Beman project's use of GitHub codespaces due to maintenance burden, and a poor developer experience caused by excessive load times for launching the codespace instances.
Information about how to install CMake, LLVM, and MSVC is a quick Google search away. This document is more valuable if we stick to the information that's specifically relevant to building Beman libraries.
There are no major changes to the substance of what the document communicates in this commit, but it rephrases some of the language to make it clearer.
neatudarius
approved these changes
Mar 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.