Repository Public License
1<!--2ORIX Audio3File: docs/development/setup.md4Author: Simon-Pierre Boucher5Contact: contact@spboucher.ai6-->78# Development Setup910## Requirements1112| Tool | Version used | Notes |13|---|---|---|14| macOS | 27.0 | Apple silicon |15| Xcode | 27.2 (Swift 6.4.2, iOS 27.2 SDK) | |16| iOS simulator runtime | 26.5 | the only runtime installed during development |17| XcodeGen | any recent | `brew install xcodegen` |18| Python 3 with Pillow, numpy, cairosvg; `rsvg-convert` | | only for the icon, badge and diagram scripts |19| ffmpeg | | only to regenerate the test fixtures |2021The app targets iOS and iPadOS 26.0. The core package declares iOS 26 and macOS 26 and needs Swift tools 6.2.2223## First build2425```bash26git clone <repository> && cd orix-audio27xcodegen generate28open ORIXAudio.xcodeproj29```3031`ORIXAudio.xcodeproj` is generated from `project.yml` and ignored by git. Regenerate it after adding or moving files.3233Command line:3435```bash36Scripts/build.sh # Debug build for the simulator named "ORIXAudio iPhone"37SIM="iPhone 17 Pro" Scripts/build.sh # any other simulator38```3940Create the simulators the scripts expect:4142```bash43xcrun simctl create "ORIXAudio iPhone" "iPhone 17 Pro"44xcrun simctl create "ORIXAudio iPad" "iPad Pro 13-inch (M5)"45```4647## Signing4849`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](../release/testflight.md).5051## Scripts5253| Script | Purpose |54|---|---|55| `Scripts/build.sh` | generate the project and build, printing errors only |56| `Scripts/test.sh core\|app\|ui` | run a test suite |57| `Scripts/sim.sh <png> <seconds> [args…]` | install, launch with debug arguments, take a screenshot |58| `Scripts/screenshots.sh` | regenerate `docs/screenshots` |59| `Scripts/bench-transcription.sh` | synthesise the reference passages and measure error rates |60| `Scripts/l10n.py [--check]` | rebuild the string catalogs; report untranslated strings |61| `Scripts/make-icon.py` | regenerate the icon and brand assets |62| `Scripts/make-badges.py` | regenerate the README badges |63| `docs/assets/diagrams/make-diagrams.py` | regenerate the SVG diagrams |6465## Debug launch arguments6667Compiled only into Debug builds (`ORIXAudio/App/DebugHooks.swift`). They exist for tests and screenshots.6869| Argument | Effect |70|---|---|71| `-ORIXUITesting` | in-memory library and a throw-away settings domain |72| `-ORIXSkipWelcome` | marks the welcome and consent screens as seen |73| `-ORIXInput <file>` | feeds the capture pipeline from an audio file, paced in real time |74| `-ORIXAutoRecord <seconds>` | starts recording at launch; `0` keeps recording |75| `-ORIXPreset <name>` | preset for auto-record |76| `-ORIXImport <a>,<b>` | imports files at launch |77| `-ORIXRecoverAll` | recovers every interrupted capture |78| `-ORIXSection <name>` | record, library, actions, settings |79| `-ORIXOpen <text>` | opens the first recording whose title contains the text |80| `-ORIXPanel <name>` | info, spectrum, spectrogram, analysis, transcript, notes |81| `-ORIXEditor` | opens the editor |82| `-ORIXLoadTranscript <json>`, `-ORIXLoadNotes <json>` | attach saved engine output to the opened recording |83| `-ORIXTranscribe <locale>`, `-ORIXSummarize` | run the engines at launch |8485The 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.8687## Adding a string8889Write 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`.9091## Source conventions9293- Every source file starts with the project header (name, file path, one-line description, author, contact).94- Swift 6 language mode with complete concurrency checking; no third-party packages.95- DSP stays in the core package and has a reference-signal test.96- Nothing personal is committed: no recordings, transcripts, keys or certificates (`.gitignore` covers build products, signing material and environment files).97