Installation

Headroom is written in Haskell, you can either use pre-built binaries, or build in on your own from source code.

Using Homebrew¶

If you use macOS, you can install Headroom easily from Homebrew using the following command:

$ brew install norcane/tools/headroom

Using Pre-built Binaries¶

Pre-built binaries (x64) are available for GNU/Linux and macOS and can be downloaded for selected release from releases page.

From Source Code¶

Headroom is written in Haskell, so you can install it from source code either using Cabal or Stack.

Note

You might need to install the pcre C library dependencies, if you're getting errors during the build. This can be done either by brew install pcre on macOS, or apt-get install libpcre3-dev (or similar) on GNU/Linux.

Using Cabal¶

install Cabal for your platform
run cabal install headroom
add $HOME/.cabal/bin to your $PATH

Using Stack¶

install Stack for your platform
clone this repository
run stack install in the project directory
add $HOME/.local/bin to your $PATH