From 09e9baa769c997f1373c5ec677d879e6b34f48c1 Mon Sep 17 00:00:00 2001 From: Maksym Vlasov Date: Tue, 7 Jun 2022 13:04:00 +0300 Subject: [PATCH] chore: Add Windows-related instructions (#395) --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index d1222a32a..21bdcec00 100644 --- a/README.md +++ b/README.md @@ -167,6 +167,26 @@ curl -L "$(curl -s https://api.github.com/repos/minamijoyo/hcledit/releases/late +
Windows 10/11 + +We highly recommend using [WSL/WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) with Ubuntu and following the Ubuntu installation guide. Or use Docker. + +> Note: We won't be able to help with issues that can't be reproduced in Linux/Mac. +> So, try to find a working solution and send PR before open an issue. + +Otherwise, you can follow [this gist](https://gist.github.com/etiennejeanneaurevolve/1ed387dc73c5d4cb53ab313049587d09): + +1. Install [`git`](https://git-scm.com/downloads) and [`gitbash`](https://gitforwindows.org/) +2. Install [Python 3](https://www.python.org/downloads/) +3. Install all prerequisites needed (see above) + +Ensure your PATH environment variable looks for `bash.exe` in `C:\Program Files\Git\bin` (the one present in `C:\Windows\System32\bash.exe` does not work with `pre-commit.exe`) + +For `checkov`, you may need to also set your `PYTHONPATH` environment variable with the path to your Python modules. +E.g. `C:\Users\USERNAME\AppData\Local\Programs\Python\Python39\Lib\site-packages` + +
+ ### 2. Install the pre-commit hook globally