Skip to content

Commit eae424a

Browse files
committed
Trim README and remove product brief
1 parent cb096cf commit eae424a

3 files changed

Lines changed: 2 additions & 127 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@
99

1010
## Sources of truth
1111

12-
- `README.md` documents shipped workflows and validation commands.
12+
- `README.md` documents shipped workflows and the quick start.
1313
- `coreai.md` contains notes from the local SDK interfaces.
14-
- `PRODUCT.md` describes product direction. Do not present planned work as implemented.
1514
- `CoreAIFrameworkLab.xcodeproj` is the Xcode project source of truth. Make target, package, build-setting, file-membership, and shared-scheme changes directly in Xcode, then commit the resulting project changes. Do not introduce a project generator.
1615
- `CoreAILab/Resources/AppleModels/apple-coreai-models.json` is generated by `Scripts/update_apple_model_catalog.py`. Keep its source revision aligned with the pinned `coreai-models` package revision in the Xcode project and related documentation.
1716

@@ -80,7 +79,7 @@ uv run pytest -q
8079

8180
- Use Swift Testing (`import Testing`, `@Test`, `#expect`, `#require`) and deterministic local fixtures for new Swift tests.
8281
- Keep tests that need external model assets opt-in through their existing `COREAI_*` environment variables. Do not download weights, authenticate to external services, or add credentials to the repository as part of the default suite.
83-
- Run `Scripts/run_device_tests.py` only for physical iOS Core AI behavior and only when an unlocked iOS 27+ device and existing signing assets are available. Start with `--dry-run`; never enable provisioning updates automatically. See `README.md` for the exact contract.
82+
- Run `Scripts/run_device_tests.py` only for physical iOS Core AI behavior and only when an unlocked iOS 27+ device and existing signing assets are available. Start with `--dry-run`; never enable provisioning updates automatically. Run `python3 Scripts/run_device_tests.py --help` for the exact contract.
8483
- Match validation to the change. Documentation-only changes do not need a full Xcode build; Swift behavior changes need the relevant build and tests, and platform-specific behavior needs validation on that platform. Report any unavailable hardware, model, signing, or toolchain prerequisite explicitly.
8584

8685
## PR comment loop

PRODUCT.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

README.md

Lines changed: 0 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ benchmarking, and packaging models with Apple's `CoreAI.framework`.
3131
- [Common Workflows](#common-workflows)
3232
- [Model Workflows](#model-workflows)
3333
- [For Contributors and Agents](#for-contributors-and-agents)
34-
- [Repository Map](#repository-map)
35-
- [Validation](#validation)
3634
- [Current Boundaries](#current-boundaries)
3735
- [Documentation](#documentation)
3836
- [License](#license)
@@ -171,88 +169,7 @@ Detailed conversion and evidence commands live in:
171169

172170
- Target: iOS 27 and macOS 27 with Xcode 27 and Swift 6.4.
173171
- Read [`AGENTS.md`](AGENTS.md) before changing code.
174-
- Treat [`PRODUCT.md`](PRODUCT.md) as direction, not shipped behavior.
175-
- Use [`CoreAIFrameworkLab.xcodeproj`](CoreAIFrameworkLab.xcodeproj/) as the
176-
project source of truth; no project generator is required or supported.
177172
- Verify unfamiliar Core AI APIs against the selected Xcode 27 SDK before use.
178-
- Keep claims measurable: preference is not placement, and cache state is not
179-
performance evidence.
180-
181-
## Repository Map
182-
183-
| Path | Purpose |
184-
| --- | --- |
185-
| [`CoreAILab/`](CoreAILab/) | SwiftUI app, feature views, workspace models, and resources. |
186-
| [`CoreAILabCore/`](CoreAILabCore/) | Shared runtime, persistence, conversion, recipes, pipelines, and export logic. |
187-
| [`CoreAILabTests/`](CoreAILabTests/) | Swift Testing suites and opt-in integration tests. |
188-
| [`Conversion/`](Conversion/) | Python 3.12 conversion and parity projects. |
189-
| [`Documentation/`](Documentation/) | Recipe-bundle guide and schema. |
190-
| [`Scripts/`](Scripts/) | Catalog, fixture, CI, and physical-device helpers. |
191-
| [`.github/ci/`](.github/ci/) | Hosted and hardware CI boundaries. |
192-
193-
## Validation
194-
195-
Match validation to the change. Documentation-only edits do not need a full
196-
Xcode build.
197-
198-
### macOS app and Swift tests
199-
200-
```bash
201-
export DEVELOPER_DIR=/Applications/Xcode-beta.app/Contents/Developer
202-
203-
xcodebuild -project CoreAIFrameworkLab.xcodeproj \
204-
-scheme CoreAILabMac \
205-
-destination 'platform=macOS,arch=arm64' \
206-
-derivedDataPath ./build/Xcode27 \
207-
build
208-
209-
xcodebuild -project CoreAIFrameworkLab.xcodeproj \
210-
-scheme CoreAILabMac \
211-
-destination 'platform=macOS,arch=arm64' \
212-
-derivedDataPath ./build/Xcode27 \
213-
test
214-
```
215-
216-
### Script tests
217-
218-
```bash
219-
python3 -m unittest discover -s Scripts/tests -p 'test_*.py'
220-
```
221-
222-
### Conversion tests
223-
224-
```bash
225-
cd Conversion/Chatterbox
226-
uv sync
227-
uv run pytest -q
228-
229-
cd ../Diarization
230-
uv sync
231-
uv run pytest -q
232-
```
233-
234-
### Physical iOS fixture
235-
236-
1. Connect and unlock one iOS 27+ device.
237-
2. Confirm Developer Mode and existing local signing assets.
238-
3. Start with a dry run:
239-
240-
```bash
241-
export DEVELOPER_DIR=/Applications/Xcode-beta.app/Contents/Developer
242-
243-
python3 Scripts/run_device_tests.py \
244-
--team YOUR_TEAM_ID \
245-
--device YOUR_PHYSICAL_DEVICE_UDID \
246-
--profile YOUR_INSTALLED_PROFILE_UUID \
247-
--dry-run \
248-
--evidence-json TestResults/iphone-dry-run.json
249-
```
250-
251-
4. Remove `--dry-run`, choose a new evidence path, and rerun.
252-
5. Import the resulting JSON into **Device Lab**.
253-
254-
The harness never enables provisioning updates. See
255-
[`.github/ci/README.md`](.github/ci/README.md) for CI and hardware-runner setup.
256173

257174
## Current Boundaries
258175

@@ -282,7 +199,6 @@ The harness never enables provisioning updates. See
282199
## Documentation
283200

284201
- [`AGENTS.md`](AGENTS.md) — implementation and review rules
285-
- [`PRODUCT.md`](PRODUCT.md) — product direction and design principles
286202
- [`coreai.md`](coreai.md) — locally verified Xcode 27 SDK notes
287203
- [`Documentation/RECIPE_BUNDLES.md`](Documentation/RECIPE_BUNDLES.md) — bundle format and trust boundary
288204
- [`.github/ci/README.md`](.github/ci/README.md) — CI and hardware-runner contract

0 commit comments

Comments
 (0)