Skip to content

Commit a3f973d

Browse files
committed
docs: Add Sample Projects section to AGENTS.md
Document TargetName/Sources, Resources, Configuration structure, Info.plist/entitlements in Configuration, .gitkeep for empty dirs, and make build-samples / xcode-ci commands.
1 parent 859eb9a commit a3f973d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,14 @@ The repository includes a Makefile that contains common commands for building, t
588588
- To build the SDK for macOS use `make build-macos`, for iOS use `make build-ios`
589589
- To run tests use `make test-macos` or `make test-ios` for the respective platforms.
590590

591+
### Sample Projects
592+
593+
- **Structure**: `TargetName/Sources`, `TargetName/Resources`, `TargetName/Configuration` (e.g. `App/Sources`, `App/Resources`, `App/Configuration`)
594+
- **Info.plist and entitlements**: Live in `Configuration/`, not `Resources/`
595+
- **Empty directories**: Add `.gitkeep` to empty Sources, Resources, Configuration dirs so git tracks the layout
596+
- **Build**: `make build-samples` (all) or `make build-sample-<name>` (e.g. `make build-sample-iOS-Swift`)
597+
- **Regenerate projects**: `make xcode-ci` (all) or `make xcode-ci-<name>` (e.g. `make xcode-ci-SPM`)
598+
591599
## Shell Script Conventions
592600

593601
- **Use named parameters** (`--since`, `--output`) over positional parameters (`$1`, `$2`) to prevent wrong parameters being passed as scripts evolve
@@ -602,6 +610,8 @@ The repository includes a Makefile that contains common commands for building, t
602610
- start test server (rarely needed): `make run-test-server`
603611
- stop test server: `make stop-test-server`
604612
- build the XCFramework deliverables: `make build-xcframework`
613+
- build all sample apps: `make build-samples`
614+
- regenerate sample Xcode projects: `make xcode-ci`
605615
- lint pod deliverable: `make pod-lint`
606616

607617
## Resources & Documentation

0 commit comments

Comments
 (0)