Skip to content

Commit 1678178

Browse files
committed
A few clarifications.
1 parent 79fb697 commit 1678178

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,12 @@ The end goal is for the entire compiler to be written in Gren.
1717
To build the compiler:
1818

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

22-
You can now execute the compiler with `node ./cli.js` or just `./cli.js`. The Gren-part of the compiler will download a pre-built
23-
binary of the Haskell-part from Github. If you want to run the compiler with the Haskell-part you've built yourself, set the path
24-
to the Haskell-binary in a `GREN_BIN` environment variable.
22+
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,
23+
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
24+
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
25+
to the Haskell-binary in a `GREN_BIN` environment variable, like: `GREN_BIN=$PWD/gren node ./cli.js`.
2526

26-
Don't forget to check the `scripts` defined in `devbox.json`. They can be executed using `devbox run <script>`.
27+
You might also want to study the scripts defined in `devbox.json`. You can execute one of these scripts by running
28+
`devbox run <script_name>`.

0 commit comments

Comments
 (0)