From a4a89a549d192921edaf74d132c10c7abae219f1 Mon Sep 17 00:00:00 2001 From: Joshua Nelson Date: Tue, 29 Sep 2020 11:43:11 -0400 Subject: [PATCH] Add windows instructions --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd83cea2..99e78149 100644 --- a/README.md +++ b/README.md @@ -81,12 +81,20 @@ The build files are found in the `book` directory. We also test that line lengths are less than 100 columns. To test this locally, you can run `ci/check_line_lengths.sh`. -You can also set this to run automatically with the following command: +You can also set this to run automatically. + +On Linux: ```bash ln -s ../../ci/check_line_lengths.sh .git/hooks/pre-commit ``` +On Windows: + +```powershell +cd .git/hooks && New-Item -Path ../../.git_hooks/* -ItemType SymbolicLink -Value . && cd ../.. +``` + ### Link Validations We use `mdbook-linkcheck` to validate URLs included in our documentation. To perform link checks, uncomment the `[output.linkcheck]` field in the `book.toml` configuration file and install `mdbook-linkcheck` with: