ci: add examples building and testing to all platforms

Author: Sqhh99

.github/workflows/builds.yml

@@ -41,11 +41,11 @@ jobs:
       matrix:
         include:
           - os: ubuntu-latest
-            preset: linux-release
+            preset: linux-release-examples
           - os: macos-latest
-            preset: macos-release
+            preset: macos-release-examples
           - os: windows-latest
-            preset: windows-release
+            preset: windows-release-examples
     name: ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 
@@ -84,7 +84,8 @@ jobs:
             libasound2-dev libpulse-dev \
             libssl-dev \
             libprotobuf-dev protobuf-compiler \
-            libabsl-dev
+            libabsl-dev \
+            libwayland-dev libdecor-0-dev  # For SDL3
 
       - name: Install system deps (macOS)
         if: runner.os == 'macOS'
@@ -128,23 +129,29 @@ jobs:
       - name: Build
         run: cmake --build --preset ${{ matrix.preset }}
 
-      - name: Smoke test example (Unix)
+      - name: Smoke test examples (Unix)
         if: runner.os != 'Windows'
         shell: bash
         run: |
-          if [[ -x build/bin/SimpleRoom ]]; then
-            build/bin/SimpleRoom --help || true
-          elif [[ -x build/examples/SimpleRoom ]]; then
-            build/examples/SimpleRoom --help || true
-          fi
-
-      - name: Smoke test example (Windows)
+          set -x
+          # Find and test examples
+          for exe in SimpleRoom SimpleRpc SimpleDataStream; do
+            if [[ -x "build/bin/${exe}" ]]; then
+              build/bin/${exe} --help || true
+            fi
+          done
+
+      - name: Smoke test examples (Windows)
         if: runner.os == 'Windows'
         shell: pwsh
         run: |
-          $exePath = "build/bin/release/SimpleRoom.exe"
-          if (Test-Path $exePath) {
-            & $exePath --help
+          $examples = @('SimpleRoom', 'SimpleRpc', 'SimpleDataStream')
+          foreach ($exe in $examples) {
+            $exePath = "build/bin/Release/${exe}.exe"
+            if (Test-Path $exePath) {
+              Write-Host "Testing ${exe}..."
+              & $exePath --help
+            }
           }
 
       - name: Upload build artifacts
@@ -154,6 +161,7 @@ jobs:
           path: |
             build/lib/
             build/include/
+            build/bin/
           retention-days: 7
 
       - name: Clean after build (best-effort)

DEPENDENCIES.md

@@ -8,9 +8,37 @@ The LiveKit SDK consists of two static libraries:
 - `livekit.lib` (or `liblivekit.a` on Unix)
 - `livekit_ffi.lib` (or `liblivekit_ffi.a` on Unix)
 
-**IMPORTANT**: 
-- **Windows**: All dependencies (protobuf, abseil) are included as DLLs in the distribution. You just need to copy them alongside your executable.
-- **Linux/macOS**: You must install protobuf and abseil via your system package manager (apt/brew). The SDK links dynamically against these libraries.
+## Distribution Model
+
+The SDK uses different distribution strategies per platform:
+
+### Windows (Complete Package)
+✅ **Ready to use** - All dependencies included:
+- `livekit.lib` - Main SDK static library
+- `livekit_ffi.dll` + `livekit_ffi.dll.lib` - Rust FFI layer
+- `libprotobuf.dll` + `libprotobuf.lib` - Protocol Buffers runtime
+- `abseil_dll.dll` + `abseil_dll.lib` - Abseil C++ library
+
+**User action**: Copy all DLLs alongside your executable. No additional installation required.
+
+### Linux (Minimal Package)
+⚠️ **Requires system dependencies**:
+- `liblivekit.a` - Main SDK static library (included)
+- `liblivekit_ffi.a` - Rust FFI layer (included)
+- `libprotobuf` - Must install via `apt install libprotobuf-dev`
+- `libssl` - Must install via `apt install libssl-dev`
+- `libabsl` - Only if built with Protobuf 6.0+: `apt install libabsl-dev`
+
+**User action**: Install required packages on target system before linking.
+
+### macOS (Minimal Package)
+⚠️ **Requires system dependencies**:
+- `liblivekit.a` - Main SDK static library (included)
+- `liblivekit_ffi.a` - Rust FFI layer (included)
+- `protobuf` - Must install via `brew install protobuf`
+- `abseil` - Only if built with Protobuf 6.0+: `brew install abseil`
+
+**User action**: Install required packages on target system before linking.
 
 ---
 

README.md

@@ -12,9 +12,18 @@ This SDK enables native C++ applications to connect to LiveKit servers for real-
   You must install Git LFS before cloning or pulling the repo if you want to run the examples.
 
 **Platform-Specific Requirements:**
-- **Windows:** Visual Studio 2019+, vcpkg (dependencies bundled in distribution)
-- **Linux:** `sudo apt install libprotobuf-dev libabsl-dev libssl-dev`
-- **macOS:** `brew install protobuf abseil`
+
+### For Building the SDK:
+- **Windows:** Visual Studio 2019+, vcpkg
+- **Linux:** `sudo apt install libprotobuf-dev libssl-dev` (protobuf 3.x)
+- **macOS:** `brew install protobuf` (protobuf 3.x)
+
+### For Using the Pre-built SDK:
+- **Windows:** ✅ All dependencies included (DLLs bundled) - ready to use
+- **Linux:** ⚠️ Requires `libprotobuf` and `libssl-dev` installed on target system
+- **macOS:** ⚠️ Requires `protobuf` installed via Homebrew on target system
+
+> **Note**: If the SDK was built with Protobuf 6.0+, you also need `libabsl-dev` (Linux) or `abseil` (macOS).
 
 ## 🧩 Clone the Repository