diff --git a/README.md b/README.md index a718035ebdb59a7b88794b6ad3d13cbc67d80f02..6f1c81ba0e2eff15d2cf8ff3522c1ec48c9da0e9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,18 @@ Horizon is a haskell package set targetting new builds of GHC. +## Getting started + +You an can use this package set instead of your haskell packages set in +nixpkgs. To see an example you can use the template supplied with this +repository. + +``` +mkdir myProject +cd myProject +nix flake init -t 'git+https://gitlab.homotopic.tech/horizon/horizon-platform' +``` + ## Updating the package set The package set is generated from the `horizon.dhall` using the following command: