Skip to content

manual typo fix #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dezren39 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

manual typo fix #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c2d47e
manual typo fix
dezren39 Jul 13, 2025
f03351b
Update README.md
dezren39 Jul 13, 2025
6b98bc5
Update README.md
dezren39 Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@

Very much a work in progress but basic nix building works

to run the example you can run `nix build .#examples-simple --print-build-logs` in the repo root
to run the example you can run the following in the repo root
```shell
nix build .#examples-simple --print-build-logs
```

## Quick start

See [this example](./templates/quick-start/) for a simple roc app taken form [roc-parser](https://github.com/lukewilliamboswell/roc-parser/blob/main/examples/letters.roc) which builds a roc binary using 2 external deps
See [this example](./templates/quick-start/) for a simple roc app taken from [roc-parser](https://github.com/lukewilliamboswell/roc-parser/blob/main/examples/letters.roc) which builds a roc binary using 2 external deps


you can run the following to copy the template into your current folder
Expand All @@ -17,7 +20,7 @@ you can run the following to copy the template into your current folder

## How it works

NOTE: goal is to eventually have a code gen step to reduce boiler plate like node2nix but for now its all manaul
NOTE: goal is to eventually have a code gen step to reduce boiler plate like node2nix but for now its all manual

- nix is given a list of urls of roc packages with their sha256 hash
- `downloadRocPackage` will call `fetchUrl` on each package and extract the package into a directory
Expand All @@ -29,7 +32,7 @@ NOTE: goal is to eventually have a code gen step to reduce boiler plate like nod
- [ ] TLC around how roc deps are replaced by the nix store paths. Right now its basically a regex is fine for the long urls but for local file paths there is a potential for collisions
- [ ] actually verify the blake3 checksum. (since we untar roc wont do this for us). Maybe roc could support local tar balls?
- [ ] A code gen tool to get all deps of a roc package for you

- [ ] Update to roc 0.1 syntax

## Ideas to explore

Expand All @@ -42,4 +45,4 @@ Lib setup is heavily inspired by [crane](https://github.com/ipetkov/crane)
## notes

see https://github.com/JRMurr/roc/blob/3d8884a96d44e2101ce8932336b74e2b9416e029/crates/compiler/build/src/link.rs#L437
for how roc calls out to compile different platforms
for how roc calls out to compile different platforms