diff --git a/README b/README index 1c3a8f7c..79d34f03 100644 --- a/README +++ b/README @@ -8,3 +8,19 @@ cmake -G Ninja -B build cmake --build build cmake --install build ``` + +### Pre-Commit +Pre-Commit applies a git hook to the local repository such that linting is checked and applied on every `git commit` action. Install from the root of the repository using: + +```bash +source env/activate +pre-commit install +``` + +If you have already committed before installing the pre-commit hooks, you can run on all files to "catch up": + +```bash +pre-commit run --all-files +``` + +For more information visit [pre-commit](https://pre-commit.com/)