From f1638b1d6dfbae1a35ff7c95f95335269eb30d89 Mon Sep 17 00:00:00 2001 From: Robin Heggelund Hansen Date: Fri, 26 Aug 2022 09:07:07 +0200 Subject: [PATCH] Update readme, and add section on installing with ghcup. --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ae3dc32d..2a3c25a9 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # Gren -Compiler for the Gren programming language. +Compiler for the Gren, a pure functional programming language that is easy to learn, but powerful in use. -If you wish to install the compiler, you might want to read the [setup instructions](https://gren-lang.org/install). +There are easier ways to install the compiler than compiling the source, you might want to read the [setup instructions](https://gren-lang.org/install). ## Build from source -Then Gren compiler is written in Haskell, so to build from source you need to have GHC 9.2.2 (haskell compiler) and cabal 3.6 (haskell build tool) installed on your system. +Then Gren compiler is written in Haskell, so to build from source you need to have GHC 9.2 (Haskell compiler) and Cabal 3.8 (haskell build tool) installed on your system. -Compiling the project should just be a matter of running `cabal build`, or `cabal install` if you wish to install the compiler on your machine. +You can install these using [ghcup](https://www.haskell.org/ghcup/). By default, ghcup will install an older version of Haskell and Cabal, so you can install and set the required versions using `ghcup tui`. -Read the [CONTRIBUTING.md]() file for some helpful commands for working on the compiler itself. +Compiling and installing the project should just be a matter of `cabal install`, after which you should be able to run the `gren` command from your command line. + +Read the `CONTRIBUTING.md` file for some helpful commands for working on the compiler itself.