michael/csci8980-f21
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added installation instructions for fix-whitespace.

Browse source
This commit is contained in:
Wen Kokke 2020-08-19 22:19:40 +02:00
parent b5d69ff010
commit 6af8bed428
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -149,10 +149,17 @@ PLFA is written in literate Agda with [Kramdown Markdown][kramdown].
The repository comes with several Git hooks: The repository comes with several Git hooks:
1. The [fix-whitespace][fix-whitespace] program is run to check for whitespace violations. 1. The [fix-whitespace][fix-whitespace] program is run to check for whitespace violations.
2. The test suite is run to check if everything type checks. 2. The test suite is run to check if everything type checks.
You can install these Git hooks by calling `make init`. You can install these Git hooks by calling `make init`.
You can install [fix-whitespace][fix-whitespace] by running:
```bash
git clone https://github.com/agda/fix-whitespace
cd fix-whitespace/
stack install --stack-yaml stack-8.8.3.yaml
```
If you want Stack to use your system installation of GHC, you can pass the `--system-ghc` flag and select the appropriate `stack-*.yaml` file, like when installing [Agda](#installing-agda-using-stack).
### Building the website ### Building the website