summaryrefslogtreecommitdiff
path: root/misc/hooks
diff options
context:
space:
mode:
authorPouleyKetchoupp <pouleyketchoup@gmail.com>2020-03-30 22:59:06 +0200
committerPouleyKetchoupp <pouleyketchoup@gmail.com>2020-03-30 22:59:06 +0200
commit7b6e664178ce0ff559a7a5033606a089881f21b4 (patch)
tree6293c5e47d030c5ed7bcb5c0bf29cb5d0d1879ca /misc/hooks
parentb383484e445b1554c811556181a7815e0308fd62 (diff)
Pre-commit hook instructions on Windows
Diffstat (limited to 'misc/hooks')
-rw-r--r--misc/hooks/README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/misc/hooks/README.md b/misc/hooks/README.md
index dad5300a09..5661c239ed 100644
--- a/misc/hooks/README.md
+++ b/misc/hooks/README.md
@@ -20,7 +20,18 @@ contributors to make sure they comply with our requirements.
Copy all the files from this folder into your `.git/hooks` folder, and make
sure the hooks and helper scripts are executable.
+#### Linux/MacOS
+
The hooks rely on bash scripts and tools which should be in the system `PATH`,
-so they should work out of the box on Linux/macOS, and might work on Windows
-when using `git-bash.exe` with `clang-format`, Python, `black`, etc. in the
-`PATH`.
+so they should work out of the box on Linux/macOS.
+
+#### Windows
+
+##### clang-format
+- Download LLVM for Windows (version 8 or later) from
+ <https://releases.llvm.org/download.html>
+- Make sure LLVM is added to the `PATH` during installation
+
+##### black
+- Python installation: make sure Python is added to the `PATH`
+- Install `black` - in any console: `pip3 install black`