[feature/pre-commit] Removing scratch scripts and adding dev setup in…

…structions to README
qognitive · Jul 11, 2024 · dea9c0f · dea9c0f
1 parent 5b3d245
commit dea9c0f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -22,16 +22,20 @@
   - Tested Compilers GCC@12, LLVM@17, LLVM@18
 - Python >= 3.10
 
-### Dev Requirements
-- [`pre-commit`](https://pre-commit.com/)
-
+## Developer Setup
 
-### Developer Standards
+### Dev Requirements
 
 - C/C++: `clang-format` defaults
-- Python: `ruff` lint/format
+- Python: `ruff` lint/format, [`pre-commit`](https://pre-commit.com/)
 - CMake: `cmake-format`
 
+> **You need to install the `pre-commit` hooks to ensure they run before you commit code.**
+
+```shell
+# From root project dir
+pre-commit install # installs the checks as pre-commit hooks
+```
 
 ## Build and Test
 

diff --git a/examples/make_strings.py b/examples/make_strings.py