From 7440883c15075e6ff43be544abb464d6e5f43c5d Mon Sep 17 00:00:00 2001 From: Daniel Firth <dan.firth@homotopic.tech> Date: Fri, 16 Dec 2022 10:57:40 +0000 Subject: [PATCH] README.md: Add section on getting started --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a718035e..6f1c81ba 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: -- GitLab