From 81ea102a4014c419b5d1b941f0167589508657de Mon Sep 17 00:00:00 2001 From: Michael O'Keefe Date: Wed, 27 Mar 2024 14:10:49 -0600 Subject: [PATCH 1/2] Add note about clang-format versions After struggling with this, just wanted to pass along this hard-earned information for others. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8bd8414..d2a4019 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 you're 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 From 2e6c43baeb42fff7e928e8019ba652383ea09a69 Mon Sep 17 00:00:00 2001 From: Michael O'Keefe Date: Fri, 21 Jun 2024 10:29:29 -0600 Subject: [PATCH 2/2] Update README.md Fix spelling mistake. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d2a4019..57c4187 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ 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 you're 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. +**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