docs: update README to reflect CMake version and clarify build steps #31
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.
Description
This pull request resolves #30 and updates the
README.mdto clarify and modernize the documentation for building, testing, and maintaining the C++ project. The most important changes include updating build requirements, improving instructions for running and disabling unit tests, clarifying pre-commit hook usage, and enhancing the CI documentation.Build and Test Instructions:
ENABLE_UNIT_TESTSinstead ofENABLE_TESTS, and clarified the output path for the main executable (./build/bin/main_exec).Development and Maintenance Scripts:
coverage.shand clarified the usage offormat.shfor CI checks in the scripts overview table.Code Quality and Pre-commit Hooks:
pre-commit, specifying that checks now run on push (not commit), and clarified their function and automation for VS Code DevContainer users.Continuous Integration: