Skip to content

Commit 8aaf8ed

Browse files
jyn514Joshua Nelson
authored and
Joshua Nelson
committed
Add windows instructions
1 parent 4a6fd11 commit 8aaf8ed

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,20 @@ The build files are found in the `book` directory.
8181
We also test that line lengths are less than 100 columns. To test this locally,
8282
you can run `ci/check_line_lengths.sh`.
8383

84-
You can also set this to run automatically with the following command:
84+
You can also set this to run automatically.
85+
86+
On Linux:
8587

8688
```bash
8789
ln -s ../../ci/check_line_lengths.sh .git/hooks/pre-commit
8890
```
8991

92+
On Windows:
93+
94+
```powershell
95+
cd .git/hooks && New-Item -Path ../../.git_hooks/* -ItemType SymbolicLink -Value . && cd ../..
96+
```
97+
9098
### Link Validations
9199

92100
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:

0 commit comments

Comments
 (0)