From 3ed4bf92fe7ffc75357a5e75c2de25166e1bd332 Mon Sep 17 00:00:00 2001 From: Julian Antonielli Date: Thu, 19 May 2022 07:44:09 -0300 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 25102c27..22c9ff9b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # Gren -TODO +Compiler for the Gren programming language. + +## Installing + +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. + +Example (OS X): + +```bash +# Download to ~/Downloads/gren-macOS.zip +cd ~/Downloads +unzip gren-macOS.zip +chmod +x gren +mv gren /usr/local/bin/ + +gren # Success +```