Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.67 KB

README.md

File metadata and controls

28 lines (18 loc) · 1.67 KB
Raw

Gren

Compiler for Gren, a pure functional programming language that is easy to learn, but powerful in use.

There are easier ways to install the compiler than compiling the source, you might want to read the setup instructions.

Build from source

This project uses devbox for managing dependencies required to build the project. If you don't want to use devbox, you can find a list of the requried dependencies and the commands for building the compiler in devbox.json.

Since Gren 0.4 the compiler is implemented in two parts. The Gren-part of the compiler lives in src, and once built it acts as a frontend to the Haskell-part of the compiler.

The end goal is for the entire compiler to be written in Gren.

To build the compiler:

  1. Use devbox run prepare-deps to setup the required dependencies. The first time you run this it might take a while.
  2. Build the compiler with devbox run build. This will create a cli.js file and a gren executable in the project root directory.

You can now execute the Gren-part of the compiler with node ./cli.js or just ./cli.js. This either requires node to be installed, or that you've entered the development shell by using devbox shell. The Gren-part of the compiler will by default download a pre-built binary of the Haskell-part from Github. If you want to run the compiler with the Haskell-part you've just built, set the path to the Haskell-binary in a GREN_BIN environment variable, like: GREN_BIN=$PWD/gren node ./cli.js.

You might also want to study the scripts defined in devbox.json. You can execute one of these scripts by running devbox run <script_name>.