gaming/godot
gaming/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot synced 2024-10-14 13:28:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #37444 from nekomatata/hook-readme-windows

Browse source 
Pre-commit hook instructions on Windows
This commit is contained in:
Rémi Verschelde 2020-03-30 23:22:01 +02:00 committed by GitHub
parent f3c74afd28 7b6e664178
commit 2becffd4e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
misc/hooks/README.md
View file

@ -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`