mirror of
https://github.com/gren-lang/compiler.git
synced 2024-10-26 18:00:47 +03:00
Update readme, and add section on installing with ghcup.
This commit is contained in:
parent
9746d8d429
commit
f1638b1d6d
12
README.md
12
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.
|
||||
|
Loading…
Reference in New Issue
Block a user