diff --git a/README.md b/README.md index 8bd8414..57c4187 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,8 @@ IDE, which can be configured to automatically format code upon file-save. Else, * On Mac, `brew install clang-format` and run at the command line with `clang-format -i ` * On Ubuntu, `sudo apt install clang-format` and run at the command line with `clang-format -i ` +**NOTE**: ensure the version of clang-format your development team is using locally matches the version used in `.github/workflows/clang-format-check.yml` or you may get false errors. The .clang-format file can be set to a version earlier than your current. + ## Code Coverage: Codecov ## CI: GitHub Actions