Contents

gaelic-ghost/speakswiftly

Local speech for Swift apps, desktop tools, and agent workflows that need text read aloud on-device.

Table of Contents

Overview

Status

SpeakSwiftly is actively available as a macOS-only local speech package. Future mobile speech work belongs in a separate SpeakSwiftlyMobile app that can share text conditioning through TextForSpeech without inheriting this desktop worker runtime.

What This Project Is

TBD

Motivation

TBD

Quick Start

SpeakSwiftly is for local, on-device speech. It is useful when an app, automation, or agent needs speech output without handing every utterance to a remote service.

Most people should start from a higher-level host that already embeds SpeakSwiftly. Use this repository directly when you are building a Swift app, local tool, or agent runtime that needs to own speech generation itself.

For contributors and maintainers, setup and validation live in CONTRIBUTING.md.

Usage

SpeakSwiftly can be used in two ways:

  • inside apps and tools that want to speak text locally
  • behind agent workflows that need a long-running local speech helper

The project is designed around named voices, reusable text handling, visible speech queues, saved generated audio, and local resident models.

Host-integration details live in WorkerContract.md.

Development

For setup, local workflow, validation, contribution expectations, and maintainer operations, see CONTRIBUTING.md.

Agent-facing maintainer guidance lives in AGENTS.md.

Repo Structure

.
|-- Package.swift
|-- Sources/SpeakSwiftly/
|   |-- API/
|   |-- Generation/
|   |-- Normalization/
|   |-- Playback/
|   |-- Runtime/
|   `-- SpeakSwiftly.docc/
|-- Sources/SpeakSwiftlyFileAudioOutput/
|-- Sources/SpeakSwiftlyHTTPAudioOutput/
|-- Sources/SpeakSwiftlyNetworkAudioOutput/
|-- Sources/SpeakSwiftlyPlayback/
|-- Tests/SpeakSwiftlyTests/
|-- docs/maintainers/
|-- docs/releases/
`-- scripts/repo-maintenance/

Release Notes

Use GitHub releases and repository tags for the authoritative release history. Checked-in release-note snapshots and older release context live under docs/releases/, including docs/releases/release-history.md.

License

Apache License 2.0. See LICENSE and NOTICE.

Package Metadata

Repository: gaelic-ghost/speakswiftly

Default branch: main

README: README.md