Skip to content

Commit 6bcdd66

Browse files
add build steps diagram
1 parent 0a28ce9 commit 6bcdd66

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

20240704-basic-cli-build-steps.png

222 KB
Loading

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,20 @@ A Roc [platform](https://github.com/roc-lang/roc/wiki/Roc-concepts-explained#pla
1313
- [0.9.x](https://www.roc-lang.org/packages/basic-cli/0.9.1)
1414
- [0.8.x](https://www.roc-lang.org/packages/basic-cli/0.8.1)
1515
- [latest main branch](https://www.roc-lang.org/packages/basic-cli)
16+
17+
## Building the platform
18+
19+
The following diagram shows the steps for `roc build.roc` which build the platform binaries.
20+
21+
![diagram of build process](20240704-basic-cli-build-steps.png)
22+
23+
## Running an example locally
24+
25+
After building the platform, you will now have the prebuilt binaries in the `/platform` directory.
26+
27+
You can now run an example like;
28+
29+
```sh
30+
$ roc exmaples/hello-world.roc
31+
Hello, World!
32+
```

0 commit comments

Comments
 (0)