mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add windows instructions

This commit is contained in:
Joshua Nelson 2020-09-29 11:43:11 -04:00 committed by Joshua Nelson
parent 3f1414cb00
commit a4a89a549d
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

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