MCSP Algorithms

Building

To compile the project, you'll need a recent release of the Glasgow Haskell Compiler. We recommend using GHCup for managing compiler versions. You'll also need stack for building. Then, you can just do:

stack build --no-run-benchmarks --no-run-tests
stack --silent exec playground

Development

This project is set up to work with Visual Studio Code.

Dev Dependencies

• pre-commit
• HLint
• Fourmolu

Setup

Install pre-commit hooks:

pre-commit install

Commit Message

Commits should follow the Conventional Commits specification. Types in use can be found at pvdlg/conventional-commit-types.

Running Tests

stack test --no-run-benchmarks

Running Benchmarks

stack bench --no-run-tests

Haddock

HTML documentation can be generated with:

stack haddock --haddock-internal MCSP-Algorithms --open

For exposed modules only, you can drop --haddock-internal.