SPB Git

Repository Public License

setup.md 4.3 KB

# Development Setup

# Requirements

Tool Version used Notes
macOS 27.0 Apple silicon
Xcode 27.2 (Swift 6.4.2, iOS 27.2 SDK)
iOS simulator runtime 26.5 the only runtime installed during development
XcodeGen any recent brew install xcodegen
Python 3 with Pillow, numpy, cairosvg; rsvg-convert only for the icon, badge and diagram scripts
ffmpeg only to regenerate the test fixtures

The app targets iOS and iPadOS 26.0. The core package declares iOS 26 and macOS 26 and needs Swift tools 6.2.

# First build

bash
git clone <repository> && cd orix-audio
xcodegen generate
open ORIXAudio.xcodeproj

ORIXAudio.xcodeproj is generated from project.yml and ignored by git. Regenerate it after adding or moving files.

Command line:

bash
Scripts/build.sh                          # Debug build for the simulator named "ORIXAudio iPhone"
SIM="iPhone 17 Pro" Scripts/build.sh      # any other simulator

Create the simulators the scripts expect:

bash
xcrun simctl create "ORIXAudio iPhone" "iPhone 17 Pro"
xcrun simctl create "ORIXAudio iPad" "iPad Pro 13-inch (M5)"

# Signing

project.yml sets team 3YM54G49SN and automatic signing. Simulator builds are unsigned. Device and archive builds need the team's certificates and, for the command line, an App Store Connect API key supplied through the environment — never committed. See docs/release/testflight.md.

# Scripts

Script Purpose
Scripts/build.sh generate the project and build, printing errors only
Scripts/test.sh core|app|ui run a test suite
Scripts/sim.sh <png> <seconds> [args…] install, launch with debug arguments, take a screenshot
Scripts/screenshots.sh regenerate docs/screenshots
Scripts/bench-transcription.sh synthesise the reference passages and measure error rates
Scripts/l10n.py [--check] rebuild the string catalogs; report untranslated strings
Scripts/make-icon.py regenerate the icon and brand assets
Scripts/make-badges.py regenerate the README badges
docs/assets/diagrams/make-diagrams.py regenerate the SVG diagrams

# Debug launch arguments

Compiled only into Debug builds (ORIXAudio/App/DebugHooks.swift). They exist for tests and screenshots.

Argument Effect
-ORIXUITesting in-memory library and a throw-away settings domain
-ORIXSkipWelcome marks the welcome and consent screens as seen
-ORIXInput <file> feeds the capture pipeline from an audio file, paced in real time
-ORIXAutoRecord <seconds> starts recording at launch; 0 keeps recording
-ORIXPreset <name> preset for auto-record
-ORIXImport <a>,<b> imports files at launch
-ORIXRecoverAll recovers every interrupted capture
-ORIXSection <name> record, library, actions, settings
-ORIXOpen <text> opens the first recording whose title contains the text
-ORIXPanel <name> info, spectrum, spectrogram, analysis, transcript, notes
-ORIXEditor opens the editor
-ORIXLoadTranscript <json>, -ORIXLoadNotes <json> attach saved engine output to the opened recording
-ORIXTranscribe <locale>, -ORIXSummarize run the engines at launch

The file input replaces only the source of samples. From ingest onward — rings, writer thread, analysis thread, master file, finalizer — the path is the production one.

# Adding a string

Write the English text in code (Text("…"), String(localized: "…")). Build, then run Scripts/l10n.py; it lists any key without a French translation in build/l10n-missing.json. Add the translation to Localization/fr-CA.json and run the script again. Wording for values that come from the core package lives in ORIXAudio/App/CoreText.swift.

# Source conventions

  • Every source file starts with the project header (name, file path, one-line description, author, contact).
  • Swift 6 language mode with complete concurrency checking; no third-party packages.
  • DSP stays in the core package and has a reference-signal test.
  • Nothing personal is committed: no recordings, transcripts, keys or certificates (.gitignore covers build products, signing material and environment files).
Files main
Menu

Theme