mirror of
https://github.com/gren-lang/compiler.git
synced 2024-08-17 12:31:00 +03:00
Update README with the latest install and build instructions.
This commit is contained in:
parent
af99831e40
commit
a58616b4de
@ -1,4 +1,3 @@
|
||||
|
||||
# Local development commands
|
||||
|
||||
- build: `cabal build -f dev`
|
||||
|
17
README.md
17
README.md
@ -2,19 +2,12 @@
|
||||
|
||||
Compiler for the Gren programming language.
|
||||
|
||||
## Installing
|
||||
If you wish to install the compiler, you might want to read the [setup instructions](https://gren-lang.org/install).
|
||||
|
||||
Binaries are available for every commit to master [here](https://github.com/gren-lang/compiler/actions/workflows/releases.yml).
|
||||
Once downloaded, you'll need to unzip the binary and place it somewhere in your `PATH`, and give it execute permissions.
|
||||
## Build from source
|
||||
|
||||
Example (OS X):
|
||||
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.
|
||||
|
||||
```bash
|
||||
# Download to ~/Downloads/gren-macOS.zip
|
||||
cd ~/Downloads
|
||||
unzip gren-macOS.zip
|
||||
chmod +x gren
|
||||
mv gren /usr/local/bin/
|
||||
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.
|
||||
|
||||
gren # Success
|
||||
```
|
||||
Read the [CONTRIBUTING.md]() file for some helpful commands for working on the compiler itself.
|
||||
|
Loading…
Reference in New Issue
Block a user