Skip to content

Commit

Permalink
Merge pull request #7187 from jwoudenberg/improve-glue-readme
Browse files Browse the repository at this point in the history
Fix typos in creates/glue/README.md
  • Loading branch information
lukewilliamboswell authored Oct 26, 2024
2 parents 614aa67 + 5961e2d commit 8903d63
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions crates/glue/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Glue

Glue is a bit of tooling built into Roc to help with platform development. Roc platforms are written in a different language than Roc, and some it requires some finesse to let other languages to read and write Roc types like records and unions in a way compatible with how Roc uses those types.
Glue is a bit of tooling built into Roc to help with platform development. Roc platforms are written in a different language than Roc, and it requires some finesse to let other languages read and write Roc types like records and unions in a way that's compatible with how Roc uses those types.

The `roc glue` command generates code in other languages for interacting with the Roc types used by your platform. It takes three arguments:

1. A 'glue spec', this is a Roc file specifying how to output type helpers fora particular language. You can find some examples in the src/ subdirectory:
1. A 'glue spec', this is a Roc file specifying how to output type helpers for a particular language. You can find some examples in the src/ subdirectory:

- **RustGlue.roc:** Generates Roc bindings for rust platforms.
- **ZigGlue.roc:** Generates Roc bindings for zig platforms (out of date).
Expand Down

0 comments on commit 8903d63

Please sign in to comment.