Getting Started with Tintin

Requirements

Build tool

You'll have to have installed either, the stack Haskell build tool. Or runghc. The Stack installation is straightforward:

wget -qO- https://get.haskellstack.org/ | sh

Installing

You can install Tintin by issuing the following command:

wget -qO- https://github.com/theam/tintin/raw/master/assets/install | sh

We invite you to check the installation script before you run it.

If you prefer cabal over Stack, you can run:

cabal update
cabal install inliterate
cabal install tintin

Creating a new project with the Tintin template

We provide a Stack template for making your life easier when creating projects with Tintin:

stack new --resolver nightly <your-project-name> https://github.com/theam/tintin/raw/master/assets/template.hsfiles

Note: The --resolver nightly is required, as the tintin dependencies are not in LTS yet.

You are ready to roll, proceed to documenting your project!