Launcher

.github/workflows/build-all.yaml

@@ -60,18 +60,16 @@ jobs:
 
       - name: Build and run tests
         run: |
-          mkdir orca
-          $env:PATH += Convert-Path orca
-          zig build test -Dsdk-path=orca
+          zig build test
 
       - name: Build sketches
         run: |
           zig build sketches
 
       - name: Build and Package
         run: |
-          zig build -Doptimize=ReleaseFast -Dsdk-path=orca -Dversion=${{ needs.determine-version.outputs.version }} --summary all
-          tar --format=ustar -cvzf orca-windows-x64.tar.gz orca
+          zig build -Doptimize=ReleaseFast -Dversion=${{ needs.determine-version.outputs.version }} --summary all
+          tar --format=ustar -cvzf orca-windows-x64.tar.gz -C zig-out Orca
 
       - uses: actions/upload-artifact@v4
         with:
@@ -94,18 +92,16 @@ jobs:
 
       - name: Build and run tests
         run: |
-          mkdir orca
-          export PATH=$PATH:$(realpath orca)
-          zig build test -Dsdk-path=orca
+          zig build test
 
       - name: Build sketches
         run: |
           zig build sketches
 
       - name: Build and Package
         run: |
-          zig build -Doptimize=ReleaseFast -Dsdk-path=orca -Dversion=${{ needs.determine-version.outputs.version }} --summary all
-          tar --format=ustar -czf orca-mac-x64.tar.gz orca
+          zig build -Doptimize=ReleaseFast -Dversion=${{ needs.determine-version.outputs.version }} --summary all
+          tar --format=ustar -czf orca-mac-x64.tar.gz -C zig-out Orca.app
 
       - uses: actions/upload-artifact@v4
         with:
@@ -128,18 +124,16 @@ jobs:
 
       - name: Build and run tests
         run: |
-          mkdir orca
-          export PATH=$PATH:$(realpath orca)
-          zig build test -Dsdk-path=orca
+          zig build test
 
       - name: Build sketches
         run: |
           zig build sketches
 
       - name: Build and Package
         run: |
-          zig build -Doptimize=ReleaseFast -Dsdk-path=orca -Dversion=${{ needs.determine-version.outputs.version }} --summary all
-          tar --format=ustar -czf orca-mac-arm64.tar.gz orca
+          zig build -Doptimize=ReleaseFast -Dversion=${{ needs.determine-version.outputs.version }} --summary all
+          tar --format=ustar -czf orca-mac-arm64.tar.gz -C zig-out Orca.app
 
       - uses: actions/upload-artifact@v4
         with:

Readme.md

@@ -32,11 +32,7 @@ To learn more about the project and its goals, read the [announcement post](http
 - [Newsletter](https://orca-app.dev/newsletter.html)
 - [Sponsor](https://github.com/sponsors/orca-app)
 
-## Installing
-
-The Orca command-line tools must be installed to your system in order to use them in your own projects.
-
-### Requirements
+## Requirements
 
 - Windows 10 or later, or Mac 14 or later (Linux is not yet supported)
 
@@ -45,12 +41,12 @@ The Orca command-line tools must be installed to your system in order to use the
 	- **Mac users:** Apple's built-in `clang` does not support WebAssembly. We recommend installing `clang` via [Homebrew](https://brew.sh/) with `brew install llvm`.
 - **Clang runtime builtins.** When targeting WebAssembly, `clang` relies on builtins found in `libclang_rt.builtins-wasm32`, but most distributions of `clang` don't yet ship with this file. To know where `clang` expects to find this file, you can run `clang --target=wasm32 -print-libgcc-file-name`. If this file doesn't exist you will need to download it from [https://github.com/WebAssembly/wasi-sdk/releases](https://github.com/WebAssembly/wasi-sdk/releases). 
 
-### Installation Instructions
+## Installing
 
-Download the orca tool and SDK from [https://github.com/orca-app/orca/releases/latest](https://github.com/orca-app/orca/releases/latest), and put the orca folder where you want orca to be installed.
+The Orca command-line tools and SDK must be installed to your system in order to use them in your own projects. Download Orca from [https://github.com/orca-app/orca/releases/latest](https://github.com/orca-app/orca/releases/latest), and extract it where you want orca to be installed.
 
 - **Windows:**  
-	- Download `orca-windows.tar.gz`  
+	- Download `orca-windows.tar.gz`
 	- Extract: `tar -xzf orca-windows.tar.gz`
 
 - **ARM Mac:**  
@@ -61,10 +57,11 @@ Download the orca tool and SDK from [https://github.com/orca-app/orca/releases/l
 	- Download `orca-mac-x64.tar.gz`  
 	- Extract: `tar -xzf orca-mac-x64.tar.gz`
 
-Add the orca tool directory to your PATH environment variable:  
+Add the orca executable directory to your PATH environment variable:  
 
-- **Windows Instructions:** [https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14))
-- **Mac Instructions:** [https://support.apple.com/guide/terminal/use-environment-variables-apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac](https://support.apple.com/guide/terminal/use-environment-variables-apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac)
+- **Windows:** add the path of the extracted `orca` folder to you PATH environment variable. See these instructions on how to do that: [https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14))
+
+- **Mac:** the orca executable is located inside the `Orca.app` bundle. To use the executable from the command line, add `(...)/Orca.app/Contents/MacOS/orca` to your PATH environment variable (replace `(...)` with the path of the directory in which you put `Orca.app`!). See these instructions on how to modify your PATH: [https://support.apple.com/guide/terminal/use-environment-variables-apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac](https://support.apple.com/guide/terminal/use-environment-variables-apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac)
 
 Finally, verify that Orca is successfully installed by running the `orca version` command.
 
@@ -82,20 +79,22 @@ The `samples` directory contains several sample apps that demonstrate various Or
 
 ```
 cd samples/breakout
+
 # Windows
 build.bat
+
 # Mac
 ./build.sh
 ```
 
-On Windows this creates a `Breakout` directory in `samples/breakout`. You can launch the app by running `Breakout/bin/Breakout.exe`. On macOS this creates a `Breakout.app` bundle in `samples/breakout` that you can double-click to run.
+On Windows this creates a `Breakout` directory in `samples/breakout`. You can launch the app by running `orca run breakout.orca`.
 
 ## Writing an Orca app
 
-Orca apps are WebAssembly modules that use the Orca APIs. The process for creating an Orca application is:
+Orca apps are bundles that contain WebAssembly modules and resources. Creating an Orca application is a two step process:
 
-1. Compile a WebAssembly module using your language and toolchain of choice.
-2. Bundle the WebAssembly module into a native executable using the Orca command-line tools.
+1. Compile your application's code to a WebAssembly module. You can use your language of choice as long as it has bindings to the Orca APIs.
+2. Bundle the WebAssembly module and additional resources (e.g. fonts, images, etc.) into an Orca image or a standalone executable using the Orca command-line tools.
 
 For a more thorough overview, please read the [Quick Start Guide](./doc/mkdocs/docs/QuickStart.md), which will walk you through building a simple application.