https://github.com/lukewilliamboswell/roc-platform-template-zig

Zig platform template
https://github.com/lukewilliamboswell/roc-platform-template-zig

roc-lang

Last synced: 6 days ago
JSON representation

Zig platform template

• Host: GitHub
• URL: https://github.com/lukewilliamboswell/roc-platform-template-zig
• Owner: lukewilliamboswell
• License: upl-1.0
• Created: 2024-05-18T12:22:35.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-30T09:17:11.000Z (4 months ago)
• Last Synced: 2024-08-03T11:01:33.815Z (3 months ago)
• Topics: roc-lang
• Language: Roc
• Homepage:
• Size: 68.4 KB
• Stars: 0
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• roc-awesome - Zig platform template

README

        
# Roc platform template for Zig

This is a template for getting started with a [roc platform](https://www.roc-lang.org/platforms) using [Zig](https://ziglang.org).

If you have any ideas to improve this template, please let me know. 😀

I'm not an experienced zig developer; any assistance with `glue.roc` spec would be most appreciated.

## Developing locally

Build the platform with `roc build.roc` to produce the prebuilt-binaries in `platform/`.

Then you will be able to run `roc app.roc`.

## Packaging the platform

Bundle the platform source and prebuilt-binaries with `roc build --bundle .tar.br platform/main.roc`, and then upload to a URL.

## Platform documentation

Generate the documentation with `roc docs platform/main.roc` and then serve the files in `generated-docs/` using a webserver.

## Advaced - LLVM IR

You can generate the LLVM IR for the app with `roc build --emit-llvm-ir app.roc` which is an authoritative reference for what roc will generate in the application object.