hmn
/
orca
5
Fork 2
Code Issues 21 Pull Requests 1 Packages Projects Releases Wiki Activity

zig-sample: add README

This commit is contained in:
Reuben Dunnington 2023-09-25 22:07:46 -04:00
parent 7a91ba471e
commit 1af327d353
Signed by: rdunnington
GPG Key ID: 3D57C8938EA08E90
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
samples/zig-sample/README.md Normal file
View File

@ -0,0 +1,16 @@
### Build and run
Zig version `0.11.0` or greater is required for this sample. To build and run:
```
orca dev build-runtime
zig build run
```
These two commands build the runtime - the native host executable - and the sample as a loadable wasm library, then runs it. To only build the sample without running it, use `zig build bundle`.
### Warning
Zig integration is still in-progress and experimental. You may encounter bugs since not all the bound APIs have been tested extensively - this sample is currently the only code doing so! Additionally, not all APIs have zig coverage yet, notably:
* `oc_str8`, `oc_str16`, `oc_str32`: partial coverage
* `oc_ui`: none
* `gles`: none
Please report any bugs you find on the Handmade discord in the #orca channel.