Talon/voice-cat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
voice-cat/README.md

69 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
# VoiceCat
Self-hosted, native voice & text chat in the spirit of classic TeamSpeak / Mumble —
channel-based voice, channel + private text, one server you run yourself. Plain **TCP**
(control) and **UDP** (media), no WebRTC. Encrypted by default. A shared **C++ core**
(`libvoicecat`) drives native clients (Swift on macOS/iOS, C# on Windows) and the server.
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
> **Status:** Design complete in [`docs/`](docs/). M1–M5 are implemented — real TLS control
> plane, encrypted UDP voice (Opus), multi-stream, TOFU identity pinning, channel tree,
> permissions, moderation, disconnect/keepalive/reaper. Windows WinForms C# client shipped
> (M4). macOS/iOS Swift client is next. See [`PROGRESS.md`](PROGRESS.md) and
> [`docs/roadmap.md`](docs/roadmap.md).
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
## Read the design first
The [`docs/`](docs/) folder is the source of truth. Start at [`docs/README.md`](docs/README.md),
then `architecture` → `protocol` → `voice` → `security` → `tech-stack` → `deployment` →
`roadmap`.
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
## Build
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
The default development preset is **`dev`** — it builds everything (server + tools + tests)
with real vcpkg deps. It works on Windows, Linux, and macOS (vcpkg triplet auto-resolved).
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
```bash
build: bundle vcpkg as a git submodule, pinned to the manifest baseline Adds vcpkg as a submodule at vcpkg/, pinned to the exact commit vcpkg.json already declares as builtin-baseline, so the bundled checkout and the manifest's resolved port versions can never drift apart. cmake/voicecat-toolchain.cmake, scripts/common.sh, and clients/apple/scripts/build-xcframework.sh now resolve vcpkg as: VCPKG_ROOT env var (external checkout) > bundled submodule. Docs updated to describe the new one-time setup. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-03 10:42:42 +01:00
# one-time vcpkg setup (bundled as a submodule, pinned to vcpkg.json's builtin-baseline):
git submodule update --init vcpkg
./vcpkg/bootstrap-vcpkg.sh # .bat on Windows
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
# configure + build + test:
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
cmake --preset dev
cmake --build --preset dev
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
ctest --preset dev # 21 behavior tests
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
```
build: bundle vcpkg as a git submodule, pinned to the manifest baseline Adds vcpkg as a submodule at vcpkg/, pinned to the exact commit vcpkg.json already declares as builtin-baseline, so the bundled checkout and the manifest's resolved port versions can never drift apart. cmake/voicecat-toolchain.cmake, scripts/common.sh, and clients/apple/scripts/build-xcframework.sh now resolve vcpkg as: VCPKG_ROOT env var (external checkout) > bundled submodule. Docs updated to describe the new one-time setup. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-03 10:42:42 +01:00
To use an external vcpkg checkout instead, set `VCPKG_ROOT=/path/to/vcpkg` (or
`$env:VCPKG_ROOT` on PowerShell) — it always takes priority over the bundled submodule.
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
Artifacts land in `build/dev/bin/` (`voicecat-server`, `vccli`, `voicecat-admin`).
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
The `skeleton` preset (no vcpkg deps, stubs only) is a fast smoke check that needs no
third-party libraries:
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
```bash
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
cmake --preset skeleton && cmake --build --preset skeleton && ctest --preset skeleton
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
```
build(cmake): clean up presets, add release/apple presets, cross-platform triplets Rationalize the preset set to match the project's actual state (past M5): - Rename dev->skeleton (no-deps stub smoke), m1-dev->dev (default dev preset) - Drop m2-dev (cache-identical to m1-dev) - Add release preset (optimized + tests on, symbols kept) - Strip server-release binaries (-s linker flag) - Add apple-dev/apple-ios/apple-ios-sim scaffolding presets for XCFramework Add cmake/voicecat-toolchain.cmake wrapper that auto-resolves the vcpkg triplet from the host platform (x64-mingw-static/x64-linux/arm64-osx) so the main presets work on Windows/Linux/macOS without per-OS variants. Update all docs (building.md, CLAUDE.md, README.md, AGENTS.md, deployment.md, tech-stack.md, client READMEs) and stale preset-name references in code comments. No C++ behavior changes — the core was already portable.
2026-06-18 03:16:01 +02:00
See [`docs/building.md`](docs/building.md) for the full preset matrix (including `release`,
`server-release`, `windows-client`, and Apple platform scaffolding).
scaffold: M0 skeleton + agent onboarding (build, architecture, progress) Turn the design into a buildable, dependency-free M0 skeleton plus the onboarding layer so a new agent can pick up instantly. Build system: - CMake + CMakePresets (dev = no deps; server-release = vcpkg) + vcpkg.json - Skeleton builds with just a C++20 compiler; deps stay off until needed - .gitattributes (LF), .gitignore, .clang-format Core (libvoicecat): - core/include/voicecat.h: full C ABI (the client/server contract), stubbed - core/proto/voicecat.proto: control-plane wire format, matches docs/protocol.md - src/{net,crypto,codec,protocol,session,audio,core}: subsystem stubs that return VC_ERR_NOT_IMPLEMENTED, each pointing to its design doc - server/ (voicecat-server) and tools/vccli/ link the core - tests/: CTest smoke test asserting the C ABI contract (behavior, not just build) - clients/{apple,windows}: M4 placeholders Onboarding for agents: - CLAUDE.md: hub — build/test commands, architecture at a glance, doc map, rules - AGENTS.md: working method (behavior-driven; clean compile is the floor not the goal) - PROGRESS.md: living tracker — M0 done, M1 task checklist, "where we left off" Verified: cmake --preset dev && cmake --build --preset dev && ctest --preset dev → green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 21:09:09 +02:00
## Layout
```
docs/ design spec (read this)
core/ libvoicecat — the shared C++ core
include/ voicecat.h (the C ABI all clients call)
proto/ voicecat.proto (control-plane wire format, source of truth)
src/ net/ crypto/ codec/ protocol/ session/ audio/ (stubs today)
server/ voicecat-server (headless; links the core)
tools/vccli/ headless test client — drives the protocol from M1 on
clients/ apple/ (Swift, M4) windows/ (C#, M4) — placeholders for now
tests/ CTest targets
```
## License
Permissive-only dependencies (no GPL/LGPL) so the project can be redistributed freely,
including closed-source. Project license: TBD (see [`docs/tech-stack.md`](docs/tech-stack.md) §5).
Reference in New Issue Copy Permalink