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

Added section on Git hooks to README.

Browse source
This commit is contained in:
Wen Kokke 2020-08-19 22:05:51 +02:00
parent b172ea93af
commit ec4694070e
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -143,6 +143,16 @@ You'll see the key sequence of the character in mini buffer.
PLFA is available as both a website and an EPUB e-book, both of which can be built on Linux and macOS.
PLFA is written in literate Agda with [Kramdown Markdown][kramdown].
### Git hooks
The repository comes with several pre-commit Git hooks installed:
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.
If you don’t have [fix-whitespace][fix-whitespace] installed, you can circumvent the pre-commit Git hooks by passing `--no-verify`.
### Building the website
The website version of the book is built in three stages:
@ -223,6 +233,8 @@ The EPUB is written to `out/epub/plfa.epub`.
[haskell-stack]: https://docs.haskellstack.org/en/stable/README/
[haskell-ghc]: https://www.haskell.org/ghc/
[fix-whitespace]: https://github.com/agda/fix-whitespace
[mononoki]: https://madmalik.github.io/mononoki/
[ruby]: https://www.ruby-lang.org/en/documentation/installation/